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

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\HeaderUtils;
  15. use Symfony\Component\HttpFoundation\RedirectResponse;
  16. use Symfony\Component\HttpFoundation\Request;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\HttpKernel\Exception\HttpException;
  19. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  21. /**
  22.  * Redirects a request to another URL.
  23.  *
  24.  * @author Fabien Potencier <fabien@symfony.com>
  25.  *
  26.  * @final
  27.  */
  28. class RedirectController
  29. {
  30.     private $router;
  31.     private $httpPort;
  32.     private $httpsPort;
  34.     public function __construct(?UrlGeneratorInterface $router = null, ?int $httpPort = null, ?int $httpsPort = null)
  35.     {
  36.         $this->router = $router;
  37.         $this->httpPort = $httpPort;
  38.         $this->httpsPort = $httpsPort;
  39.     }
  41.     /**
  42.      * Redirects to another route with the given name.
  43.      *
  44.      * The response status code is 302 if the permanent parameter is false (default),
  45.      * and 301 if the redirection is permanent.
  46.      *
  47.      * In case the route name is empty, the status code will be 404 when permanent is false
  48.      * and 410 otherwise.
  49.      *
  50.      * @param string     $route             The route name to redirect to
  51.      * @param bool       $permanent         Whether the redirection is permanent
  52.      * @param bool|array $ignoreAttributes  Whether to ignore attributes or an array of attributes to ignore
  53.      * @param bool       $keepRequestMethod Whether redirect action should keep HTTP request method
  54.      *
  55.      * @throws HttpException In case the route name is empty
  56.      */
  57.     public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response
  58.     {
  59.         if ('' == $route) {
  60.             throw new HttpException($permanent ? 410 : 404);
  61.         }
  63.         $attributes = [];
  64.         if (false === $ignoreAttributes || \is_array($ignoreAttributes)) {
  65.             $attributes = $request->attributes->get('_route_params');
  67.             if ($keepQueryParams) {
  68.                 if ($query = $request->server->get('QUERY_STRING')) {
  69.                     $query = HeaderUtils::parseQuery($query);
  70.                 } else {
  71.                     $query = $request->query->all();
  72.                 }
  74.                 $attributes = array_merge($query, $attributes);
  75.             }
  77.             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod'], $attributes['keepQueryParams']);
  78.             if ($ignoreAttributes) {
  79.                 $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));
  80.             }
  81.         }
  83.         if ($keepRequestMethod) {
  84.             $statusCode = $permanent ? 308 : 307;
  85.         } else {
  86.             $statusCode = $permanent ? 301 : 302;
  87.         }
  89.         return new RedirectResponse($this->router->generate($route, $attributes, UrlGeneratorInterface::ABSOLUTE_URL), $statusCode);
  90.     }
  92.     /**
  93.      * Redirects to a URL.
  94.      *
  95.      * The response status code is 302 if the permanent parameter is false (default),
  96.      * and 301 if the redirection is permanent.
  97.      *
  98.      * In case the path is empty, the status code will be 404 when permanent is false
  99.      * and 410 otherwise.
  100.      *
  101.      * @param string      $path              The absolute path or URL to redirect to
  102.      * @param bool        $permanent         Whether the redirect is permanent or not
  103.      * @param string|null $scheme            The URL scheme (null to keep the current one)
  104.      * @param int|null    $httpPort          The HTTP port (null to keep the current one for the same scheme or the default configured port)
  105.      * @param int|null    $httpsPort         The HTTPS port (null to keep the current one for the same scheme or the default configured port)
  106.      * @param bool        $keepRequestMethod Whether redirect action should keep HTTP request method
  107.      *
  108.      * @throws HttpException In case the path is empty
  109.      */
  110.     public function urlRedirectAction(Request $request, string $path, bool $permanent = false, ?string $scheme = null, ?int $httpPort = null, ?int $httpsPort = null, bool $keepRequestMethod = false): Response
  111.     {
  112.         if ('' === $path) {
  113.             throw new HttpException($permanent ? 410 : 404);
  114.         }
  116.         if ($keepRequestMethod) {
  117.             $statusCode = $permanent ? 308 : 307;
  118.         } else {
  119.             $statusCode = $permanent ? 301 : 302;
  120.         }
  122.         if (null === $scheme) {
  123.             $scheme = $request->getScheme();
  124.         }
  126.         if (str_starts_with($path, '//')) {
  127.             $path = $scheme.':'.$path;
  128.         }
  130.         // redirect if the path is a full URL
  131.         if (parse_url($path, \PHP_URL_SCHEME)) {
  132.             return new RedirectResponse($path, $statusCode);
  133.         }
  136.         if ($qs = $request->server->get('QUERY_STRING') ?: $request->getQueryString()) {
  137.             if (!str_contains($path, '?')) {
  138.                 $qs = '?'.$qs;
  139.             } else {
  140.                 $qs = '&'.$qs;
  141.             }
  142.         }
  144.         $port = '';
  145.         if ('http' === $scheme) {
  146.             if (null === $httpPort) {
  147.                 if ('http' === $request->getScheme()) {
  148.                     $httpPort = $request->getPort();
  149.                 } else {
  150.                     $httpPort = $this->httpPort;
  151.                 }
  152.             }
  154.             if (null !== $httpPort && 80 != $httpPort) {
  155.                 $port = ":$httpPort";
  156.             }
  157.         } elseif ('https' === $scheme) {
  158.             if (null === $httpsPort) {
  159.                 if ('https' === $request->getScheme()) {
  160.                     $httpsPort = $request->getPort();
  161.                 } else {
  162.                     $httpsPort = $this->httpsPort;
  163.                 }
  164.             }
  166.             if (null !== $httpsPort && 443 != $httpsPort) {
  167.                 $port = ":$httpsPort";
  168.             }
  169.         }
  171.         $url = $scheme.'://'.$request->getHost().$port.$request->getBaseUrl().$path.$qs;
  173.         return new RedirectResponse($url, $statusCode);
  174.     }
  176.     public function __invoke(Request $request): Response
  177.     {
  178.         $p = $request->attributes->get('_route_params', []);
  180.         if (\array_key_exists('route', $p)) {
  181.             if (\array_key_exists('path', $p)) {
  182.                 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')));
  183.             }
  185.             return $this->redirectAction($request, $p['route'], $p['permanent'] ?? false, $p['ignoreAttributes'] ?? false, $p['keepRequestMethod'] ?? false, $p['keepQueryParams'] ?? false);
  186.         }
  188.         if (\array_key_exists('path', $p)) {
  189.             return $this->urlRedirectAction($request, $p['path'], $p['permanent'] ?? false, $p['scheme'] ?? null, $p['httpPort'] ?? null, $p['httpsPort'] ?? null, $p['keepRequestMethod'] ?? false);
  190.         }
  192.         throw new \RuntimeException(sprintf('The parameter "path" or "route" is required to configure the redirect action in "%s" routing configuration.', $request->attributes->get('_route')));
  193.     }
  194. }