vendor/symfony/routing/Generator/UrlGenerator.php line 191

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Routing\Generator;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Routing\Exception\InvalidParameterException;
  16. use Symfony\Component\Routing\Exception\MissingMandatoryParametersException;
  17. use Symfony\Component\Routing\Exception\RouteNotFoundException;
  18. use Symfony\Component\Routing\RequestContext;
  19. use Symfony\Component\Routing\RouteCollection;
  21. /**
  22.  * UrlGenerator can generate a URL or a path for any route in the RouteCollection
  23.  * based on the passed parameters.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  * @author Tobias Schultze <http://tobion.de>
  27.  */
  28. class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInterface
  29. {
  30.     private const QUERY_FRAGMENT_DECODED = [
  31.         // RFC 3986 explicitly allows those in the query/fragment to reference other URIs unencoded
  32.         '%2F' => '/',
  33.         '%252F' => '%2F',
  34.         '%3F' => '?',
  35.         // reserved chars that have no special meaning for HTTP URIs in a query or fragment
  36.         // this excludes esp. "&", "=" and also "+" because PHP would treat it as a space (form-encoded)
  37.         '%40' => '@',
  38.         '%3A' => ':',
  39.         '%21' => '!',
  40.         '%3B' => ';',
  41.         '%2C' => ',',
  42.         '%2A' => '*',
  43.     ];
  45.     protected $routes;
  46.     protected $context;
  48.     /**
  49.      * @var bool|null
  50.      */
  51.     protected $strictRequirements = true;
  53.     protected $logger;
  55.     private ?string $defaultLocale;
  57.     /**
  58.      * This array defines the characters (besides alphanumeric ones) that will not be percent-encoded in the path segment of the generated URL.
  59.      *
  60.      * PHP's rawurlencode() encodes all chars except "a-zA-Z0-9-._~" according to RFC 3986. But we want to allow some chars
  61.      * to be used in their literal form (reasons below). Other chars inside the path must of course be encoded, e.g.
  62.      * "?" and "#" (would be interpreted wrongly as query and fragment identifier),
  63.      * "'" and """ (are used as delimiters in HTML).
  64.      */
  65.     protected $decodedChars = [
  66.         // the slash can be used to designate a hierarchical structure and we want allow using it with this meaning
  67.         // some webservers don't allow the slash in encoded form in the path for security reasons anyway
  68.         // see http://stackoverflow.com/questions/4069002/http-400-if-2f-part-of-get-url-in-jboss
  69.         '%2F' => '/',
  70.         '%252F' => '%2F',
  71.         // the following chars are general delimiters in the URI specification but have only special meaning in the authority component
  72.         // so they can safely be used in the path in unencoded form
  73.         '%40' => '@',
  74.         '%3A' => ':',
  75.         // these chars are only sub-delimiters that have no predefined meaning and can therefore be used literally
  76.         // so URI producing applications can use these chars to delimit subcomponents in a path segment without being encoded for better readability
  77.         '%3B' => ';',
  78.         '%2C' => ',',
  79.         '%3D' => '=',
  80.         '%2B' => '+',
  81.         '%21' => '!',
  82.         '%2A' => '*',
  83.         '%7C' => '|',
  84.     ];
  86.     public function __construct(RouteCollection $routes, RequestContext $context, LoggerInterface $logger = null, string $defaultLocale = null)
  87.     {
  88.         $this->routes = $routes;
  89.         $this->context = $context;
  90.         $this->logger = $logger;
  91.         $this->defaultLocale = $defaultLocale;
  92.     }
  94.     /**
  95.      * {@inheritdoc}
  96.      */
  97.     public function setContext(RequestContext $context)
  98.     {
  99.         $this->context = $context;
  100.     }
  102.     /**
  103.      * {@inheritdoc}
  104.      */
  105.     public function getContext(): RequestContext
  106.     {
  107.         return $this->context;
  108.     }
  110.     /**
  111.      * {@inheritdoc}
  112.      */
  113.     public function setStrictRequirements(?bool $enabled)
  114.     {
  115.         $this->strictRequirements = $enabled;
  116.     }
  118.     /**
  119.      * {@inheritdoc}
  120.      */
  121.     public function isStrictRequirements(): ?bool
  122.     {
  123.         return $this->strictRequirements;
  124.     }
  126.     /**
  127.      * {@inheritdoc}
  128.      */
  129.     public function generate(string $name, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH): string
  130.     {
  131.         $route = null;
  132.         $locale = $parameters['_locale'] ?? $this->context->getParameter('_locale') ?: $this->defaultLocale;
  134.         if (null !== $locale) {
  135.             do {
  136.                 if (null !== ($route = $this->routes->get($name.'.'.$locale)) && $route->getDefault('_canonical_route') === $name) {
  137.                     break;
  138.                 }
  139.             } while (false !== $locale = strstr($locale, '_', true));
  140.         }
  142.         if (null === $route ??= $this->routes->get($name)) {
  143.             throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $name));
  144.         }
  146.         // the Route has a cache of its own and is not recompiled as long as it does not get modified
  147.         $compiledRoute = $route->compile();
  149.         $defaults = $route->getDefaults();
  150.         $variables = $compiledRoute->getVariables();
  152.         if (isset($defaults['_canonical_route']) && isset($defaults['_locale'])) {
  153.             if (!\in_array('_locale', $variables, true)) {
  154.                 unset($parameters['_locale']);
  155.             } elseif (!isset($parameters['_locale'])) {
  156.                 $parameters['_locale'] = $defaults['_locale'];
  157.             }
  158.         }
  160.         return $this->doGenerate($variables, $defaults, $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens(), $route->getSchemes());
  161.     }
  163.     /**
  164.      * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
  165.      * @throws InvalidParameterException           When a parameter value for a placeholder is not correct because
  166.      *                                             it does not match the requirement
  167.      */
  168.     protected function doGenerate(array $variables, array $defaults, array $requirements, array $tokens, array $parameters, string $name, int $referenceType, array $hostTokens, array $requiredSchemes = []): string
  169.     {
  170.         $variables = array_flip($variables);
  171.         $mergedParams = array_replace($defaults, $this->context->getParameters(), $parameters);
  173.         // all params must be given
  174.         if ($diff = array_diff_key($variables, $mergedParams)) {
  175.             throw new MissingMandatoryParametersException($name, array_keys($diff));
  176.         }
  178.         $url = '';
  179.         $optional = true;
  180.         $message = 'Parameter "{parameter}" for route "{route}" must match "{expected}" ("{given}" given) to generate a corresponding URL.';
  181.         foreach ($tokens as $token) {
  182.             if ('variable' === $token[0]) {
  183.                 $varName = $token[3];
  184.                 // variable is not important by default
  185.                 $important = $token[5] ?? false;
  187.                 if (!$optional || $important || !\array_key_exists($varName, $defaults) || (null !== $mergedParams[$varName] && (string) $mergedParams[$varName] !== (string) $defaults[$varName])) {
  188.                     // check requirement (while ignoring look-around patterns)
  189.                     if (null !== $this->strictRequirements && !preg_match('#^'.preg_replace('/\(\?(?:=|<=|!|<!)((?:[^()\\\\]+|\\\\.|\((?1)\))*)\)/', '', $token[2]).'$#i'.(empty($token[4]) ? '' : 'u'), $mergedParams[$token[3]] ?? '')) {
  190.                         if ($this->strictRequirements) {
  191.                             throw new InvalidParameterException(strtr($message, ['{parameter}' => $varName, '{route}' => $name, '{expected}' => $token[2], '{given}' => $mergedParams[$varName]]));
  192.                         }
  194.                         $this->logger?->error($message, ['parameter' => $varName, 'route' => $name, 'expected' => $token[2], 'given' => $mergedParams[$varName]]);
  196.                         return '';
  197.                     }
  199.                     $url = $token[1].$mergedParams[$varName].$url;
  200.                     $optional = false;
  201.                 }
  202.             } else {
  203.                 // static text
  204.                 $url = $token[1].$url;
  205.                 $optional = false;
  206.             }
  207.         }
  209.         if ('' === $url) {
  210.             $url = '/';
  211.         }
  213.         // the contexts base URL is already encoded (see Symfony\Component\HttpFoundation\Request)
  214.         $url = strtr(rawurlencode($url), $this->decodedChars);
  216.         // the path segments "." and ".." are interpreted as relative reference when resolving a URI; see http://tools.ietf.org/html/rfc3986#section-3.3
  217.         // so we need to encode them as they are not used for this purpose here
  218.         // otherwise we would generate a URI that, when followed by a user agent (e.g. browser), does not match this route
  219.         $url = strtr($url, ['/../' => '/%2E%2E/', '/./' => '/%2E/']);
  220.         if (str_ends_with($url, '/..')) {
  221.             $url = substr($url, 0, -2).'%2E%2E';
  222.         } elseif (str_ends_with($url, '/.')) {
  223.             $url = substr($url, 0, -1).'%2E';
  224.         }
  226.         $schemeAuthority = '';
  227.         $host = $this->context->getHost();
  228.         $scheme = $this->context->getScheme();
  230.         if ($requiredSchemes) {
  231.             if (!\in_array($scheme, $requiredSchemes, true)) {
  232.                 $referenceType = self::ABSOLUTE_URL;
  233.                 $scheme = current($requiredSchemes);
  234.             }
  235.         }
  237.         if ($hostTokens) {
  238.             $routeHost = '';
  239.             foreach ($hostTokens as $token) {
  240.                 if ('variable' === $token[0]) {
  241.                     // check requirement (while ignoring look-around patterns)
  242.                     if (null !== $this->strictRequirements && !preg_match('#^'.preg_replace('/\(\?(?:=|<=|!|<!)((?:[^()\\\\]+|\\\\.|\((?1)\))*)\)/', '', $token[2]).'$#i'.(empty($token[4]) ? '' : 'u'), $mergedParams[$token[3]])) {
  243.                         if ($this->strictRequirements) {
  244.                             throw new InvalidParameterException(strtr($message, ['{parameter}' => $token[3], '{route}' => $name, '{expected}' => $token[2], '{given}' => $mergedParams[$token[3]]]));
  245.                         }
  247.                         $this->logger?->error($message, ['parameter' => $token[3], 'route' => $name, 'expected' => $token[2], 'given' => $mergedParams[$token[3]]]);
  249.                         return '';
  250.                     }
  252.                     $routeHost = $token[1].$mergedParams[$token[3]].$routeHost;
  253.                 } else {
  254.                     $routeHost = $token[1].$routeHost;
  255.                 }
  256.             }
  258.             if ($routeHost !== $host) {
  259.                 $host = $routeHost;
  260.                 if (self::ABSOLUTE_URL !== $referenceType) {
  261.                     $referenceType = self::NETWORK_PATH;
  262.                 }
  263.             }
  264.         }
  266.         if (self::ABSOLUTE_URL === $referenceType || self::NETWORK_PATH === $referenceType) {
  267.             if ('' !== $host || ('' !== $scheme && 'http' !== $scheme && 'https' !== $scheme)) {
  268.                 $port = '';
  269.                 if ('http' === $scheme && 80 !== $this->context->getHttpPort()) {
  270.                     $port = ':'.$this->context->getHttpPort();
  271.                 } elseif ('https' === $scheme && 443 !== $this->context->getHttpsPort()) {
  272.                     $port = ':'.$this->context->getHttpsPort();
  273.                 }
  275.                 $schemeAuthority = self::NETWORK_PATH === $referenceType || '' === $scheme ? '//' : "$scheme://";
  276.                 $schemeAuthority .= $host.$port;
  277.             }
  278.         }
  280.         if (self::RELATIVE_PATH === $referenceType) {
  281.             $url = self::getRelativePath($this->context->getPathInfo(), $url);
  282.         } else {
  283.             $url = $schemeAuthority.$this->context->getBaseUrl().$url;
  284.         }
  286.         // add a query string if needed
  287.         $extra = array_udiff_assoc(array_diff_key($parameters, $variables), $defaults, function ($a, $b) {
  288.             return $a == $b ? 0 : 1;
  289.         });
  291.         array_walk_recursive($extra, $caster = static function (&$v) use (&$caster) {
  292.             if (\is_object($v)) {
  293.                 if ($vars = get_object_vars($v)) {
  294.                     array_walk_recursive($vars, $caster);
  295.                     $v = $vars;
  296.                 } elseif (method_exists($v, '__toString')) {
  297.                     $v = (string) $v;
  298.                 }
  299.             }
  300.         });
  302.         // extract fragment
  303.         $fragment = $defaults['_fragment'] ?? '';
  305.         if (isset($extra['_fragment'])) {
  306.             $fragment = $extra['_fragment'];
  307.             unset($extra['_fragment']);
  308.         }
  310.         if ($extra && $query = http_build_query($extra, '', '&', \PHP_QUERY_RFC3986)) {
  311.             $url .= '?'.strtr($query, self::QUERY_FRAGMENT_DECODED);
  312.         }
  314.         if ('' !== $fragment) {
  315.             $url .= '#'.strtr(rawurlencode($fragment), self::QUERY_FRAGMENT_DECODED);
  316.         }
  318.         return $url;
  319.     }
  321.     /**
  322.      * Returns the target path as relative reference from the base path.
  323.      *
  324.      * Only the URIs path component (no schema, host etc.) is relevant and must be given, starting with a slash.
  325.      * Both paths must be absolute and not contain relative parts.
  326.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  327.      * Furthermore, they can be used to reduce the link size in documents.
  328.      *
  329.      * Example target paths, given a base path of "/a/b/c/d":
  330.      * - "/a/b/c/d"     -> ""
  331.      * - "/a/b/c/"      -> "./"
  332.      * - "/a/b/"        -> "../"
  333.      * - "/a/b/c/other" -> "other"
  334.      * - "/a/x/y"       -> "../../x/y"
  335.      *
  336.      * @param string $basePath   The base path
  337.      * @param string $targetPath The target path
  338.      */
  339.     public static function getRelativePath(string $basePath, string $targetPath): string
  340.     {
  341.         if ($basePath === $targetPath) {
  342.             return '';
  343.         }
  345.         $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
  346.         $targetDirs = explode('/', isset($targetPath[0]) && '/' === $targetPath[0] ? substr($targetPath, 1) : $targetPath);
  347.         array_pop($sourceDirs);
  348.         $targetFile = array_pop($targetDirs);
  350.         foreach ($sourceDirs as $i => $dir) {
  351.             if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
  352.                 unset($sourceDirs[$i], $targetDirs[$i]);
  353.             } else {
  354.                 break;
  355.             }
  356.         }
  358.         $targetDirs[] = $targetFile;
  359.         $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
  361.         // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
  362.         // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
  363.         // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
  364.         // (see http://tools.ietf.org/html/rfc3986#section-4.2).
  365.         return '' === $path || '/' === $path[0]
  366.             || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
  367.             ? "./$path" : $path;
  368.     }
  369. }