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

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.         '%3F' => '?',
  34.         // reserved chars that have no special meaning for HTTP URIs in a query or fragment
  35.         // this excludes esp. "&", "=" and also "+" because PHP would treat it as a space (form-encoded)
  36.         '%40' => '@',
  37.         '%3A' => ':',
  38.         '%21' => '!',
  39.         '%3B' => ';',
  40.         '%2C' => ',',
  41.         '%2A' => '*',
  42.     ];
  44.     protected $routes;
  45.     protected $context;
  47.     /**
  48.      * @var bool|null
  49.      */
  50.     protected $strictRequirements = true;
  52.     protected $logger;
  54.     private $defaultLocale;
  56.     /**
  57.      * This array defines the characters (besides alphanumeric ones) that will not be percent-encoded in the path segment of the generated URL.
  58.      *
  59.      * PHP's rawurlencode() encodes all chars except "a-zA-Z0-9-._~" according to RFC 3986. But we want to allow some chars
  60.      * to be used in their literal form (reasons below). Other chars inside the path must of course be encoded, e.g.
  61.      * "?" and "#" (would be interpreted wrongly as query and fragment identifier),
  62.      * "'" and """ (are used as delimiters in HTML).
  63.      */
  64.     protected $decodedChars = [
  65.         // the slash can be used to designate a hierarchical structure and we want allow using it with this meaning
  66.         // some webservers don't allow the slash in encoded form in the path for security reasons anyway
  67.         // see http://stackoverflow.com/questions/4069002/http-400-if-2f-part-of-get-url-in-jboss
  68.         '%2F' => '/',
  69.         '%252F' => '%2F',
  70.         // the following chars are general delimiters in the URI specification but have only special meaning in the authority component
  71.         // so they can safely be used in the path in unencoded form
  72.         '%40' => '@',
  73.         '%3A' => ':',
  74.         // these chars are only sub-delimiters that have no predefined meaning and can therefore be used literally
  75.         // so URI producing applications can use these chars to delimit subcomponents in a path segment without being encoded for better readability
  76.         '%3B' => ';',
  77.         '%2C' => ',',
  78.         '%3D' => '=',
  79.         '%2B' => '+',
  80.         '%21' => '!',
  81.         '%2A' => '*',
  82.         '%7C' => '|',
  83.     ];
  85.     public function __construct(RouteCollection $routes, RequestContext $context, LoggerInterface $logger = null, string $defaultLocale = null)
  86.     {
  87.         $this->routes = $routes;
  88.         $this->context = $context;
  89.         $this->logger = $logger;
  90.         $this->defaultLocale = $defaultLocale;
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function setContext(RequestContext $context)
  97.     {
  98.         $this->context = $context;
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function getContext()
  105.     {
  106.         return $this->context;
  107.     }
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     public function setStrictRequirements(?bool $enabled)
  113.     {
  114.         $this->strictRequirements = $enabled;
  115.     }
  117.     /**
  118.      * {@inheritdoc}
  119.      */
  120.     public function isStrictRequirements()
  121.     {
  122.         return $this->strictRequirements;
  123.     }
  125.     /**
  126.      * {@inheritdoc}
  127.      */
  128.     public function generate(string $name, array $parameters = [], int $referenceType = self::ABSOLUTE_PATH)
  129.     {
  130.         $route = null;
  131.         $locale = $parameters['_locale']
  132.             ?? $this->context->getParameter('_locale')
  133.             ?: $this->defaultLocale;
  135.         if (null !== $locale) {
  136.             do {
  137.                 if (null !== ($route = $this->routes->get($name.'.'.$locale)) && $route->getDefault('_canonical_route') === $name) {
  138.                     break;
  139.                 }
  140.             } while (false !== $locale = strstr($locale, '_', true));
  141.         }
  143.         if (null === $route = $route ?? $this->routes->get($name)) {
  144.             throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', $name));
  145.         }
  147.         // the Route has a cache of its own and is not recompiled as long as it does not get modified
  148.         $compiledRoute = $route->compile();
  150.         $defaults = $route->getDefaults();
  151.         $variables = $compiledRoute->getVariables();
  153.         if (isset($defaults['_canonical_route']) && isset($defaults['_locale'])) {
  154.             if (!\in_array('_locale', $variables, true)) {
  155.                 unset($parameters['_locale']);
  156.             } elseif (!isset($parameters['_locale'])) {
  157.                 $parameters['_locale'] = $defaults['_locale'];
  158.             }
  159.         }
  161.         return $this->doGenerate($variables, $defaults, $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens(), $route->getSchemes());
  162.     }
  164.     /**
  165.      * @return string
  166.      *
  167.      * @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
  168.      * @throws InvalidParameterException           When a parameter value for a placeholder is not correct because
  169.      *                                             it does not match the requirement
  170.      */
  171.     protected function doGenerate(array $variables, array $defaults, array $requirements, array $tokens, array $parameters, string $name, int $referenceType, array $hostTokens, array $requiredSchemes = [])
  172.     {
  173.         $variables = array_flip($variables);
  174.         $mergedParams = array_replace($defaults, $this->context->getParameters(), $parameters);
  176.         // all params must be given
  177.         if ($diff = array_diff_key($variables, $mergedParams)) {
  178.             throw new MissingMandatoryParametersException(sprintf('Some mandatory parameters are missing ("%s") to generate a URL for route "%s".', implode('", "', array_keys($diff)), $name));
  179.         }
  181.         $url = '';
  182.         $optional = true;
  183.         $message = 'Parameter "{parameter}" for route "{route}" must match "{expected}" ("{given}" given) to generate a corresponding URL.';
  184.         foreach ($tokens as $token) {
  185.             if ('variable' === $token[0]) {
  186.                 $varName = $token[3];
  187.                 // variable is not important by default
  188.                 $important = $token[5] ?? false;
  190.                 if (!$optional || $important || !\array_key_exists($varName, $defaults) || (null !== $mergedParams[$varName] && (string) $mergedParams[$varName] !== (string) $defaults[$varName])) {
  191.                     // check requirement (while ignoring look-around patterns)
  192.                     if (null !== $this->strictRequirements && !preg_match('#^'.preg_replace('/\(\?(?:=|<=|!|<!)((?:[^()\\\\]+|\\\\.|\((?1)\))*)\)/', '', $token[2]).'$#i'.(empty($token[4]) ? '' : 'u'), $mergedParams[$token[3]] ?? '')) {
  193.                         if ($this->strictRequirements) {
  194.                             throw new InvalidParameterException(strtr($message, ['{parameter}' => $varName, '{route}' => $name, '{expected}' => $token[2], '{given}' => $mergedParams[$varName]]));
  195.                         }
  197.                         if ($this->logger) {
  198.                             $this->logger->error($message, ['parameter' => $varName, 'route' => $name, 'expected' => $token[2], 'given' => $mergedParams[$varName]]);
  199.                         }
  201.                         return '';
  202.                     }
  204.                     $url = $token[1].$mergedParams[$varName].$url;
  205.                     $optional = false;
  206.                 }
  207.             } else {
  208.                 // static text
  209.                 $url = $token[1].$url;
  210.                 $optional = false;
  211.             }
  212.         }
  214.         if ('' === $url) {
  215.             $url = '/';
  216.         }
  218.         // the contexts base URL is already encoded (see Symfony\Component\HttpFoundation\Request)
  219.         $url = strtr(rawurlencode($url), $this->decodedChars);
  221.         // the path segments "." and ".." are interpreted as relative reference when resolving a URI; see http://tools.ietf.org/html/rfc3986#section-3.3
  222.         // so we need to encode them as they are not used for this purpose here
  223.         // otherwise we would generate a URI that, when followed by a user agent (e.g. browser), does not match this route
  224.         $url = strtr($url, ['/../' => '/%2E%2E/', '/./' => '/%2E/']);
  225.         if (str_ends_with($url, '/..')) {
  226.             $url = substr($url, 0, -2).'%2E%2E';
  227.         } elseif (str_ends_with($url, '/.')) {
  228.             $url = substr($url, 0, -1).'%2E';
  229.         }
  231.         $schemeAuthority = '';
  232.         $host = $this->context->getHost();
  233.         $scheme = $this->context->getScheme();
  235.         if ($requiredSchemes) {
  236.             if (!\in_array($scheme, $requiredSchemes, true)) {
  237.                 $referenceType = self::ABSOLUTE_URL;
  238.                 $scheme = current($requiredSchemes);
  239.             }
  240.         }
  242.         if ($hostTokens) {
  243.             $routeHost = '';
  244.             foreach ($hostTokens as $token) {
  245.                 if ('variable' === $token[0]) {
  246.                     // check requirement (while ignoring look-around patterns)
  247.                     if (null !== $this->strictRequirements && !preg_match('#^'.preg_replace('/\(\?(?:=|<=|!|<!)((?:[^()\\\\]+|\\\\.|\((?1)\))*)\)/', '', $token[2]).'$#i'.(empty($token[4]) ? '' : 'u'), $mergedParams[$token[3]])) {
  248.                         if ($this->strictRequirements) {
  249.                             throw new InvalidParameterException(strtr($message, ['{parameter}' => $token[3], '{route}' => $name, '{expected}' => $token[2], '{given}' => $mergedParams[$token[3]]]));
  250.                         }
  252.                         if ($this->logger) {
  253.                             $this->logger->error($message, ['parameter' => $token[3], 'route' => $name, 'expected' => $token[2], 'given' => $mergedParams[$token[3]]]);
  254.                         }
  256.                         return '';
  257.                     }
  259.                     $routeHost = $token[1].$mergedParams[$token[3]].$routeHost;
  260.                 } else {
  261.                     $routeHost = $token[1].$routeHost;
  262.                 }
  263.             }
  265.             if ($routeHost !== $host) {
  266.                 $host = $routeHost;
  267.                 if (self::ABSOLUTE_URL !== $referenceType) {
  268.                     $referenceType = self::NETWORK_PATH;
  269.                 }
  270.             }
  271.         }
  273.         if (self::ABSOLUTE_URL === $referenceType || self::NETWORK_PATH === $referenceType) {
  274.             if ('' !== $host || ('' !== $scheme && 'http' !== $scheme && 'https' !== $scheme)) {
  275.                 $port = '';
  276.                 if ('http' === $scheme && 80 !== $this->context->getHttpPort()) {
  277.                     $port = ':'.$this->context->getHttpPort();
  278.                 } elseif ('https' === $scheme && 443 !== $this->context->getHttpsPort()) {
  279.                     $port = ':'.$this->context->getHttpsPort();
  280.                 }
  282.                 $schemeAuthority = self::NETWORK_PATH === $referenceType || '' === $scheme ? '//' : "$scheme://";
  283.                 $schemeAuthority .= $host.$port;
  284.             }
  285.         }
  287.         if (self::RELATIVE_PATH === $referenceType) {
  288.             $url = self::getRelativePath($this->context->getPathInfo(), $url);
  289.         } else {
  290.             $url = $schemeAuthority.$this->context->getBaseUrl().$url;
  291.         }
  293.         // add a query string if needed
  294.         $extra = array_udiff_assoc(array_diff_key($parameters, $variables), $defaults, function ($a, $b) {
  295.             return $a == $b ? 0 : 1;
  296.         });
  298.         array_walk_recursive($extra, $caster = static function (&$v) use (&$caster) {
  299.             if (\is_object($v)) {
  300.                 if ($vars = get_object_vars($v)) {
  301.                     array_walk_recursive($vars, $caster);
  302.                     $v = $vars;
  303.                 } elseif (method_exists($v, '__toString')) {
  304.                     $v = (string) $v;
  305.                 }
  306.             }
  307.         });
  309.         // extract fragment
  310.         $fragment = $defaults['_fragment'] ?? '';
  312.         if (isset($extra['_fragment'])) {
  313.             $fragment = $extra['_fragment'];
  314.             unset($extra['_fragment']);
  315.         }
  317.         if ($extra && $query = http_build_query($extra, '', '&', \PHP_QUERY_RFC3986)) {
  318.             $url .= '?'.strtr($query, self::QUERY_FRAGMENT_DECODED);
  319.         }
  321.         if ('' !== $fragment) {
  322.             $url .= '#'.strtr(rawurlencode($fragment), self::QUERY_FRAGMENT_DECODED);
  323.         }
  325.         return $url;
  326.     }
  328.     /**
  329.      * Returns the target path as relative reference from the base path.
  330.      *
  331.      * Only the URIs path component (no schema, host etc.) is relevant and must be given, starting with a slash.
  332.      * Both paths must be absolute and not contain relative parts.
  333.      * Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
  334.      * Furthermore, they can be used to reduce the link size in documents.
  335.      *
  336.      * Example target paths, given a base path of "/a/b/c/d":
  337.      * - "/a/b/c/d"     -> ""
  338.      * - "/a/b/c/"      -> "./"
  339.      * - "/a/b/"        -> "../"
  340.      * - "/a/b/c/other" -> "other"
  341.      * - "/a/x/y"       -> "../../x/y"
  342.      *
  343.      * @param string $basePath   The base path
  344.      * @param string $targetPath The target path
  345.      *
  346.      * @return string
  347.      */
  348.     public static function getRelativePath(string $basePath, string $targetPath)
  349.     {
  350.         if ($basePath === $targetPath) {
  351.             return '';
  352.         }
  354.         $sourceDirs = explode('/', isset($basePath[0]) && '/' === $basePath[0] ? substr($basePath, 1) : $basePath);
  355.         $targetDirs = explode('/', isset($targetPath[0]) && '/' === $targetPath[0] ? substr($targetPath, 1) : $targetPath);
  356.         array_pop($sourceDirs);
  357.         $targetFile = array_pop($targetDirs);
  359.         foreach ($sourceDirs as $i => $dir) {
  360.             if (isset($targetDirs[$i]) && $dir === $targetDirs[$i]) {
  361.                 unset($sourceDirs[$i], $targetDirs[$i]);
  362.             } else {
  363.                 break;
  364.             }
  365.         }
  367.         $targetDirs[] = $targetFile;
  368.         $path = str_repeat('../', \count($sourceDirs)).implode('/', $targetDirs);
  370.         // A reference to the same base directory or an empty subdirectory must be prefixed with "./".
  371.         // This also applies to a segment with a colon character (e.g., "file:colon") that cannot be used
  372.         // as the first segment of a relative-path reference, as it would be mistaken for a scheme name
  373.         // (see http://tools.ietf.org/html/rfc3986#section-4.2).
  374.         return '' === $path || '/' === $path[0]
  375.             || false !== ($colonPos = strpos($path, ':')) && ($colonPos < ($slashPos = strpos($path, '/')) || false === $slashPos)
  376.             ? "./$path" : $path;
  377.     }
  378. }