vendor/symfony/framework-bundle/Controller/RedirectController.php line 109

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\Bundle\FrameworkBundle\Controller;
  14. use Symfony\Component\HttpFoundation\RedirectResponse;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\HttpKernel\Exception\HttpException;
  18. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  20. /**
  21.  * Redirects a request to another URL.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  *
  25.  * @final
  26.  */
  27. class RedirectController
  28. {
  29.     private $router;
  30.     private $httpPort;
  31.     private $httpsPort;
  33.     public function __construct(UrlGeneratorInterface $router = null, int $httpPort = null, int $httpsPort = null)
  34.     {
  35.         $this->router = $router;
  36.         $this->httpPort = $httpPort;
  37.         $this->httpsPort = $httpsPort;
  38.     }
  40.     /**
  41.      * Redirects to another route with the given name.
  42.      *
  43.      * The response status code is 302 if the permanent parameter is false (default),
  44.      * and 301 if the redirection is permanent.
  45.      *
  46.      * In case the route name is empty, the status code will be 404 when permanent is false
  47.      * and 410 otherwise.
  48.      *
  49.      * @param string     $route             The route name to redirect to
  50.      * @param bool       $permanent         Whether the redirection is permanent
  51.      * @param bool|array $ignoreAttributes  Whether to ignore attributes or an array of attributes to ignore
  52.      * @param bool       $keepRequestMethod Whether redirect action should keep HTTP request method
  53.      *
  54.      * @throws HttpException In case the route name is empty
  55.      */
  56.     public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response
  57.     {
  58.         if ('' == $route) {
  59.             throw new HttpException($permanent ? 410 : 404);
  60.         }
  62.         $attributes = [];
  63.         if (false === $ignoreAttributes || \is_array($ignoreAttributes)) {
  64.             $attributes = $request->attributes->get('_route_params');
  66.             if ($keepQueryParams) {
  67.                 if ($query = $request->server->get('QUERY_STRING')) {
  68.                     $query = self::parseQuery($query);
  69.                 } else {
  70.                     $query = $request->query->all();
  71.                 }
  73.                 $attributes = array_merge($query, $attributes);
  74.             }
  76.             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod'], $attributes['keepQueryParams']);
  77.             if ($ignoreAttributes) {
  78.                 $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));
  79.             }
  80.         }
  82.         if ($keepRequestMethod) {
  83.             $statusCode = $permanent ? 308 : 307;
  84.         } else {
  85.             $statusCode = $permanent ? 301 : 302;
  86.         }
  88.         return new RedirectResponse($this->router->generate($route, $attributes, UrlGeneratorInterface::ABSOLUTE_URL), $statusCode);
  89.     }
  91.     /**
  92.      * Redirects to a URL.
  93.      *
  94.      * The response status code is 302 if the permanent parameter is false (default),
  95.      * and 301 if the redirection is permanent.
  96.      *
  97.      * In case the path is empty, the status code will be 404 when permanent is false
  98.      * and 410 otherwise.
  99.      *
  100.      * @param string      $path              The absolute path or URL to redirect to
  101.      * @param bool        $permanent         Whether the redirect is permanent or not
  102.      * @param string|null $scheme            The URL scheme (null to keep the current one)
  103.      * @param int|null    $httpPort          The HTTP port (null to keep the current one for the same scheme or the default configured port)
  104.      * @param int|null    $httpsPort         The HTTPS port (null to keep the current one for the same scheme or the default configured port)
  105.      * @param bool        $keepRequestMethod Whether redirect action should keep HTTP request method
  106.      *
  107.      * @throws HttpException In case the path is empty
  108.      */
  109.     public function urlRedirectAction(Request $request, string $path, bool $permanent = false, string $scheme = null, int $httpPort = null, int $httpsPort = null, bool $keepRequestMethod = false): Response
  110.     {
  111.         if ('' == $path) {
  112.             throw new HttpException($permanent ? 410 : 404);
  113.         }
  115.         if ($keepRequestMethod) {
  116.             $statusCode = $permanent ? 308 : 307;
  117.         } else {
  118.             $statusCode = $permanent ? 301 : 302;
  119.         }
  121.         // redirect if the path is a full URL
  122.         if (parse_url($path, \PHP_URL_SCHEME)) {
  123.             return new RedirectResponse($path, $statusCode);
  124.         }
  126.         if (null === $scheme) {
  127.             $scheme = $request->getScheme();
  128.         }
  130.         if ($qs = $request->server->get('QUERY_STRING') ?: $request->getQueryString()) {
  131.             if (!str_contains($path, '?')) {
  132.                 $qs = '?'.$qs;
  133.             } else {
  134.                 $qs = '&'.$qs;
  135.             }
  136.         }
  138.         $port = '';
  139.         if ('http' === $scheme) {
  140.             if (null === $httpPort) {
  141.                 if ('http' === $request->getScheme()) {
  142.                     $httpPort = $request->getPort();
  143.                 } else {
  144.                     $httpPort = $this->httpPort;
  145.                 }
  146.             }
  148.             if (null !== $httpPort && 80 != $httpPort) {
  149.                 $port = ":$httpPort";
  150.             }
  151.         } elseif ('https' === $scheme) {
  152.             if (null === $httpsPort) {
  153.                 if ('https' === $request->getScheme()) {
  154.                     $httpsPort = $request->getPort();
  155.                 } else {
  156.                     $httpsPort = $this->httpsPort;
  157.                 }
  158.             }
  160.             if (null !== $httpsPort && 443 != $httpsPort) {
  161.                 $port = ":$httpsPort";
  162.             }
  163.         }
  165.         $url = $scheme.'://'.$request->getHost().$port.$request->getBaseUrl().$path.$qs;
  167.         return new RedirectResponse($url, $statusCode);
  168.     }
  170.     public function __invoke(Request $request): Response
  171.     {
  172.         $p = $request->attributes->get('_route_params', []);
  174.         if (\array_key_exists('route', $p)) {
  175.             if (\array_key_exists('path', $p)) {
  176.                 throw new \RuntimeException(sprintf('Ambiguous redirection settings, use the "path" or "route" parameter, not both: "%s" and "%s" found respectively in "%s" routing configuration.', $p['path'], $p['route'], $request->attributes->get('_route')));
  177.             }
  179.             return $this->redirectAction($request, $p['route'], $p['permanent'] ?? false, $p['ignoreAttributes'] ?? false, $p['keepRequestMethod'] ?? false, $p['keepQueryParams'] ?? false);
  180.         }
  182.         if (\array_key_exists('path', $p)) {
  183.             return $this->urlRedirectAction($request, $p['path'], $p['permanent'] ?? false, $p['scheme'] ?? null, $p['httpPort'] ?? null, $p['httpsPort'] ?? null, $p['keepRequestMethod'] ?? false);
  184.         }
  186.         throw new \RuntimeException(sprintf('The parameter "path" or "route" is required to configure the redirect action in "%s" routing configuration.', $request->attributes->get('_route')));
  187.     }
  189.     private static function parseQuery(string $query)
  190.     {
  191.         $q = [];
  193.         foreach (explode('&', $query) as $v) {
  194.             if (false !== $i = strpos($v, "\0")) {
  195.                 $v = substr($v, 0, $i);
  196.             }
  198.             if (false === $i = strpos($v, '=')) {
  199.                 $k = urldecode($v);
  200.                 $v = '';
  201.             } else {
  202.                 $k = urldecode(substr($v, 0, $i));
  203.                 $v = substr($v, $i);
  204.             }
  206.             if (false !== $i = strpos($k, "\0")) {
  207.                 $k = substr($k, 0, $i);
  208.             }
  210.             $k = ltrim($k, ' ');
  212.             if (false === $i = strpos($k, '[')) {
  213.                 $q[] = bin2hex($k).$v;
  214.             } else {
  215.                 $q[] = bin2hex(substr($k, 0, $i)).rawurlencode(substr($k, $i)).$v;
  216.             }
  217.         }
  219.         parse_str(implode('&', $q), $q);
  221.         $query = [];
  223.         foreach ($q as $k => $v) {
  224.             if (false !== $i = strpos($k, '_')) {
  225.                 $query[substr_replace($k, hex2bin(substr($k, 0, $i)).'[', 0, 1 + $i)] = $v;
  226.             } else {
  227.                 $query[hex2bin($k)] = $v;
  228.             }
  229.         }
  231.         return $query;
  232.     }
  233. }