4 * This file is part of the Symfony package.
6 * (c) Fabien Potencier <fabien@symfony.com>
8 * For the full copyright and license information, please view the LICENSE
9 * file that was distributed with this source code.
12 namespace Symfony\Component\Routing\Generator;
14 use Symfony\Component\Routing\RouteCollection;
15 use Symfony\Component\Routing\RequestContext;
16 use Symfony\Component\Routing\Exception\InvalidParameterException;
17 use Symfony\Component\Routing\Exception\RouteNotFoundException;
18 use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
19 use Psr\Log\LoggerInterface;
22 * UrlGenerator can generate a URL or a path for any route in the RouteCollection
23 * based on the passed parameters.
25 * @author Fabien Potencier <fabien@symfony.com>
26 * @author Tobias Schultze <http://tobion.de>
28 class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInterface
31 * @var RouteCollection
43 protected $strictRequirements = true;
46 * @var LoggerInterface|null
51 * This array defines the characters (besides alphanumeric ones) that will not be percent-encoded in the path segment of the generated URL.
53 * PHP's rawurlencode() encodes all chars except "a-zA-Z0-9-._~" according to RFC 3986. But we want to allow some chars
54 * to be used in their literal form (reasons below). Other chars inside the path must of course be encoded, e.g.
55 * "?" and "#" (would be interpreted wrongly as query and fragment identifier),
56 * "'" and """ (are used as delimiters in HTML).
58 protected $decodedChars = array(
59 // the slash can be used to designate a hierarchical structure and we want allow using it with this meaning
60 // some webservers don't allow the slash in encoded form in the path for security reasons anyway
61 // see http://stackoverflow.com/questions/4069002/http-400-if-2f-part-of-get-url-in-jboss
63 // the following chars are general delimiters in the URI specification but have only special meaning in the authority component
64 // so they can safely be used in the path in unencoded form
67 // these chars are only sub-delimiters that have no predefined meaning and can therefore be used literally
68 // so URI producing applications can use these chars to delimit subcomponents in a path segment without being encoded for better readability
81 * @param RouteCollection $routes A RouteCollection instance
82 * @param RequestContext $context The context
83 * @param LoggerInterface|null $logger A logger instance
85 public function __construct(RouteCollection $routes, RequestContext $context, LoggerInterface $logger = null)
87 $this->routes = $routes;
88 $this->context = $context;
89 $this->logger = $logger;
95 public function setContext(RequestContext $context)
97 $this->context = $context;
103 public function getContext()
105 return $this->context;
111 public function setStrictRequirements($enabled)
113 $this->strictRequirements = null === $enabled ? null : (bool) $enabled;
119 public function isStrictRequirements()
121 return $this->strictRequirements;
127 public function generate($name, $parameters = array(), $referenceType = self::ABSOLUTE_PATH)
129 if (null === $route = $this->routes->get($name)) {
130 throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $name));
133 // the Route has a cache of its own and is not recompiled as long as it does not get modified
134 $compiledRoute = $route->compile();
136 return $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens(), $route->getSchemes());
140 * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
141 * @throws InvalidParameterException When a parameter value for a placeholder is not correct because
142 * it does not match the requirement
144 protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens, array $requiredSchemes = array())
146 if (is_bool($referenceType) || is_string($referenceType)) {
147 @trigger_error('The hardcoded value you are using for the $referenceType argument of the '.__CLASS__.'::generate method is deprecated since version 2.8 and will not be supported anymore in 3.0. Use the constants defined in the UrlGeneratorInterface instead.', E_USER_DEPRECATED);
149 if (true === $referenceType) {
150 $referenceType = self::ABSOLUTE_URL;
151 } elseif (false === $referenceType) {
152 $referenceType = self::ABSOLUTE_PATH;
153 } elseif ('relative' === $referenceType) {
154 $referenceType = self::RELATIVE_PATH;
155 } elseif ('network' === $referenceType) {
156 $referenceType = self::NETWORK_PATH;
160 $variables = array_flip($variables);
161 $mergedParams = array_replace($defaults, $this->context->getParameters(), $parameters);
163 // all params must be given
164 if ($diff = array_diff_key($variables, $mergedParams)) {
165 throw new MissingMandatoryParametersException(sprintf('Some mandatory parameters are missing ("%s") to generate a URL for route "%s".', implode('", "', array_keys($diff)), $name));
170 foreach ($tokens as $token) {
171 if ('variable' === $token[0]) {
172 if (!$optional || !array_key_exists($token[3], $defaults) || null !== $mergedParams[$token[3]] && (string) $mergedParams[$token[3]] !== (string) $defaults[$token[3]]) {
174 if (null !== $this->strictRequirements && !preg_match('#^'.$token[2].'$#', $mergedParams[$token[3]])) {
175 $message = sprintf('Parameter "%s" for route "%s" must match "%s" ("%s" given) to generate a corresponding URL.', $token[3], $name, $token[2], $mergedParams[$token[3]]);
176 if ($this->strictRequirements) {
177 throw new InvalidParameterException($message);
181 $this->logger->error($message);
187 $url = $token[1].$mergedParams[$token[3]].$url;
192 $url = $token[1].$url;
201 // the contexts base URL is already encoded (see Symfony\Component\HttpFoundation\Request)
202 $url = strtr(rawurlencode($url), $this->decodedChars);
204 // the path segments "." and ".." are interpreted as relative reference when resolving a URI; see http://tools.ietf.org/html/rfc3986#section-3.3
205 // so we need to encode them as they are not used for this purpose here
206 // otherwise we would generate a URI that, when followed by a user agent (e.g. browser), does not match this route
207 $url = strtr($url, array('/../' => '/%2E%2E/', '/./' => '/%2E/'));
208 if ('/..' === substr($url, -3)) {
209 $url = substr($url, 0, -2).'%2E%2E';
210 } elseif ('/.' === substr($url, -2)) {
211 $url = substr($url, 0, -1).'%2E';
214 $schemeAuthority = '';
215 if ($host = $this->context->getHost()) {
216 $scheme = $this->context->getScheme();
218 if ($requiredSchemes) {
219 if (!in_array($scheme, $requiredSchemes, true)) {
220 $referenceType = self::ABSOLUTE_URL;
221 $scheme = current($requiredSchemes);
223 } elseif (isset($requirements['_scheme']) && ($req = strtolower($requirements['_scheme'])) && $scheme !== $req) {
224 // We do this for BC; to be removed if _scheme is not supported anymore
225 $referenceType = self::ABSOLUTE_URL;
231 foreach ($hostTokens as $token) {
232 if ('variable' === $token[0]) {
233 if (null !== $this->strictRequirements && !preg_match('#^'.$token[2].'$#i', $mergedParams[$token[3]])) {
234 $message = sprintf('Parameter "%s" for route "%s" must match "%s" ("%s" given) to generate a corresponding URL.', $token[3], $name, $token[2], $mergedParams[$token[3]]);
236 if ($this->strictRequirements) {
237 throw new InvalidParameterException($message);
241 $this->logger->error($message);
247 $routeHost = $token[1].$mergedParams[$token[3]].$routeHost;
249 $routeHost = $token[1].$routeHost;
253 if ($routeHost !== $host) {
255 if (self::ABSOLUTE_URL !== $referenceType) {
256 $referenceType = self::NETWORK_PATH;
261 if (self::ABSOLUTE_URL === $referenceType || self::NETWORK_PATH === $referenceType) {
263 if ('http' === $scheme && 80 != $this->context->getHttpPort()) {
264 $port = ':'.$this->context->getHttpPort();
265 } elseif ('https' === $scheme && 443 != $this->context->getHttpsPort()) {
266 $port = ':'.$this->context->getHttpsPort();
269 $schemeAuthority = self::NETWORK_PATH === $referenceType ? '//' : "$scheme://";
270 $schemeAuthority .= $host.$port;
274 if (self::RELATIVE_PATH === $referenceType) {
275 $url = self::getRelativePath($this->context->getPathInfo(), $url);
277 $url = $schemeAuthority.$this->context->getBaseUrl().$url;
280 // add a query string if needed
281 $extra = array_udiff_assoc(array_diff_key($parameters, $variables), $defaults, function ($a, $b) {
282 return $a == $b ? 0 : 1;
285 if ($extra && $query = http_build_query($extra, '', '&')) {
286 // "/" and "?" can be left decoded for better user experience, see
287 // http://tools.ietf.org/html/rfc3986#section-3.4
288 $url .= '?'.strtr($query, array('%2F' => '/'));
295 * Returns the target path as relative reference from the base path.
297 * Only the URIs path component (no schema, host etc.) is relevant and must be given, starting with a slash.
298 * Both paths must be absolute and not contain relative parts.
299 * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
300 * Furthermore, they can be used to reduce the link size in documents.
302 * Example target paths, given a base path of "/a/b/c/d":
304 * - "/a/b/c/" -> "./"
306 * - "/a/b/c/other" -> "other"
307 * - "/a/x/y" -> "../../x/y"
309 * @param string $basePath The base path
310 * @param string $targetPath The target path
312 * @return string The relative target path
314 public static function getRelativePath($basePath, $targetPath)
316 if ($basePath === $targetPath) {
320 $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
321 $targetDirs = explode('/', isset($targetPath[0]) && '/' === $targetPath[0] ? substr($targetPath, 1) : $targetPath);
322 array_pop($sourceDirs);
323 $targetFile = array_pop($targetDirs);
325 foreach ($sourceDirs as $i => $dir) {
326 if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
327 unset($sourceDirs[$i], $targetDirs[$i]);
333 $targetDirs[] = $targetFile;
334 $path = str_repeat('../', count($sourceDirs)).implode('/', $targetDirs);
336 // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
337 // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
338 // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
339 // (see http://tools.ietf.org/html/rfc3986#section-4.2).
340 return '' === $path || '/' === $path[0]
341 || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)