vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php line 99

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');
  65.             $attributes = $keepQueryParams ? array_merge($request->query->all(), $attributes) : $attributes;
  66.             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod'], $attributes['keepQueryParams']);
  67.             if ($ignoreAttributes) {
  68.                 $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));
  69.             }
  70.         }
  72.         if ($keepRequestMethod) {
  73.             $statusCode = $permanent ? 308 : 307;
  74.         } else {
  75.             $statusCode = $permanent ? 301 : 302;
  76.         }
  78.         return new RedirectResponse($this->router->generate($route, $attributes, UrlGeneratorInterface::ABSOLUTE_URL), $statusCode);
  79.     }
  81.     /**
  82.      * Redirects to a URL.
  83.      *
  84.      * The response status code is 302 if the permanent parameter is false (default),
  85.      * and 301 if the redirection is permanent.
  86.      *
  87.      * In case the path is empty, the status code will be 404 when permanent is false
  88.      * and 410 otherwise.
  89.      *
  90.      * @param string      $path              The absolute path or URL to redirect to
  91.      * @param bool        $permanent         Whether the redirect is permanent or not
  92.      * @param string|null $scheme            The URL scheme (null to keep the current one)
  93.      * @param int|null    $httpPort          The HTTP port (null to keep the current one for the same scheme or the default configured port)
  94.      * @param int|null    $httpsPort         The HTTPS port (null to keep the current one for the same scheme or the default configured port)
  95.      * @param bool        $keepRequestMethod Whether redirect action should keep HTTP request method
  96.      *
  97.      * @throws HttpException In case the path is empty
  98.      */
  99.     public function urlRedirectAction(Request $request, string $path, bool $permanent = false, string $scheme = null, int $httpPort = null, int $httpsPort = null, bool $keepRequestMethod = false): Response
  100.     {
  101.         if ('' == $path) {
  102.             throw new HttpException($permanent ? 410 : 404);
  103.         }
  105.         if ($keepRequestMethod) {
  106.             $statusCode = $permanent ? 308 : 307;
  107.         } else {
  108.             $statusCode = $permanent ? 301 : 302;
  109.         }
  111.         // redirect if the path is a full URL
  112.         if (parse_url($path, PHP_URL_SCHEME)) {
  113.             return new RedirectResponse($path, $statusCode);
  114.         }
  116.         if (null === $scheme) {
  117.             $scheme = $request->getScheme();
  118.         }
  120.         $qs = $request->getQueryString();
  121.         if ($qs) {
  122.             if (false === strpos($path, '?')) {
  123.                 $qs = '?'.$qs;
  124.             } else {
  125.                 $qs = '&'.$qs;
  126.             }
  127.         }
  129.         $port = '';
  130.         if ('http' === $scheme) {
  131.             if (null === $httpPort) {
  132.                 if ('http' === $request->getScheme()) {
  133.                     $httpPort = $request->getPort();
  134.                 } else {
  135.                     $httpPort = $this->httpPort;
  136.                 }
  137.             }
  139.             if (null !== $httpPort && 80 != $httpPort) {
  140.                 $port = ":$httpPort";
  141.             }
  142.         } elseif ('https' === $scheme) {
  143.             if (null === $httpsPort) {
  144.                 if ('https' === $request->getScheme()) {
  145.                     $httpsPort = $request->getPort();
  146.                 } else {
  147.                     $httpsPort = $this->httpsPort;
  148.                 }
  149.             }
  151.             if (null !== $httpsPort && 443 != $httpsPort) {
  152.                 $port = ":$httpsPort";
  153.             }
  154.         }
  156.         $url = $scheme.'://'.$request->getHost().$port.$request->getBaseUrl().$path.$qs;
  158.         return new RedirectResponse($url, $statusCode);
  159.     }
  161.     public function __invoke(Request $request): Response
  162.     {
  163.         $p = $request->attributes->get('_route_params', []);
  165.         if (\array_key_exists('route', $p)) {
  166.             if (\array_key_exists('path', $p)) {
  167.                 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')));
  168.             }
  170.             return $this->redirectAction($request, $p['route'], $p['permanent'] ?? false, $p['ignoreAttributes'] ?? false, $p['keepRequestMethod'] ?? false, $p['keepQueryParams'] ?? false);
  171.         }
  173.         if (\array_key_exists('path', $p)) {
  174.             return $this->urlRedirectAction($request, $p['path'], $p['permanent'] ?? false, $p['scheme'] ?? null, $p['httpPort'] ?? null, $p['httpsPort'] ?? null, $p['keepRequestMethod'] ?? false);
  175.         }
  177.         throw new \RuntimeException(sprintf('The parameter "path" or "route" is required to configure the redirect action in "%s" routing configuration.', $request->attributes->get('_route')));
  178.     }
  179. }