[FrameworkBundle] keep query params in redirection

Amrouche Hamza · Amrouche Hamza · commit 5fe9639b2278 · 2018-02-23T10:54:31.000+01:00
diff --git a/src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php b/src/Symfony/Bundle/FrameworkBundle/Controller/RedirectController.php
@@ -46,26 +46,23 @@ public function __construct(UrlGeneratorInterface $router = null, int $httpPort
      * In case the route name is empty, the status code will be 404 when permanent is false
      * and 410 otherwise.
      *
-     * @param Request    $request           The request instance
-     * @param string     $route             The route name to redirect to
-     * @param bool       $permanent         Whether the redirection is permanent
-     * @param bool|array $ignoreAttributes  Whether to ignore attributes or an array of attributes to ignore
-     * @param bool       $keepRequestMethod Wheter redirect action should keep HTTP request method
+     * @param bool|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore
      *
      * @throws HttpException In case the route name is empty
      */
-    public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false): Response
+    public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response
     {
         if ('' == $route) {
             throw new HttpException($permanent ? 410 : 404);
         }
 
         $attributes = array();
-        if (false === $ignoreAttributes || is_array($ignoreAttributes)) {
-            $attributes = $request->attributes->get('_route_params');
+        if (false === $ignoreAttributes || \is_array($ignoreAttributes)) {
+            $routeParams = $request->attributes->get('_route_params');
+            $attributes = $keepQueryParams ? \array_merge($request->query->all(), $routeParams) : $routeParams;
             unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod']);
             if ($ignoreAttributes) {
-                $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));
+                $attributes = \array_diff_key($attributes, \array_flip($ignoreAttributes));
             }
         }
 
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/RedirectControllerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/RedirectControllerTest.php
@@ -78,7 +78,6 @@ public function testRoute($permanent, $keepRequestMethod, $ignoreAttributes, $ex
         $controller = new RedirectController($router);
 
         $returnResponse = $controller->redirectAction($request, $route, $permanent, $ignoreAttributes, $keepRequestMethod);
-
         $this->assertRedirectUrl($returnResponse, $url);
         $this->assertEquals($expectedCode, $returnResponse->getStatusCode());
     }
@@ -235,6 +234,25 @@ public function testPathQueryParams($expectedUrl, $path, $queryString)
         $this->assertRedirectUrl($returnValue, $expectedUrl);
     }
 
+    public function testRedirectWithQuery()
+    {
+        $scheme = 'http';
+        $host = 'www.example.com';
+        $baseUrl = '/base';
+        $port = 80;
+
+        $request = $this->createRequestObject($scheme, $host, $port, $baseUrl, 'base=zaza');
+        $request->query = new ParameterBag(['base' => 'zaza']);
+        $request->attributes = new ParameterBag(['_route_params' => []]);
+        $urlGenerator = $this->getMockBuilder(UrlGeneratorInterface::class)->getMock();
+        $urlGenerator->expects($this->any())->method('generate')->will($this->returnValue('/test?base=zaza'));
+
+        $controller = new RedirectController($urlGenerator);
+
+        $returnValue = $controller->redirectAction($request, '/test', false, false, false, true);
+        $this->assertRedirectUrl($returnValue, '/test?base=zaza');
+    }
+
     private function createRequestObject($scheme, $host, $port, $baseUrl, $queryString = '')
     {
         $request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();

Original file line number	Diff line number	Diff line change
`@@ -46,26 +46,23 @@ public function __construct(UrlGeneratorInterface $router = null, int $httpPort`
`46`	`46`	`* In case the route name is empty, the status code will be 404 when permanent is false`
`47`	`47`	`* and 410 otherwise.`
`48`	`48`	`*`
`49`		`- * @param Request $request The request instance`
`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 Wheter redirect action should keep HTTP request method`
	`49`	`+ * @param bool\|array $ignoreAttributes Whether to ignore attributes or an array of attributes to ignore`
`54`	`50`	`*`
`55`	`51`	`* @throws HttpException In case the route name is empty`
`56`	`52`	`*/`
`57`		`- public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false): Response`
	`53`	`+ public function redirectAction(Request $request, string $route, bool $permanent = false, $ignoreAttributes = false, bool $keepRequestMethod = false, bool $keepQueryParams = false): Response`
`58`	`54`	`{`
`59`	`55`	`if ('' == $route) {`
`60`	`56`	`throw new HttpException($permanent ? 410 : 404);`
`61`	`57`	`}`
`62`	`58`
`63`	`59`	`$attributes = array();`
`64`		`- if (false === $ignoreAttributes \|\| is_array($ignoreAttributes)) {`
`65`		`- $attributes = $request->attributes->get('_route_params');`
	`60`	`+ if (false === $ignoreAttributes \|\| \is_array($ignoreAttributes)) {`
	`61`	`+ $routeParams = $request->attributes->get('_route_params');`
	`62`	`+ $attributes = $keepQueryParams ? \array_merge($request->query->all(), $routeParams) : $routeParams;`
`66`	`63`	`unset($attributes['route'], $attributes['permanent'], $attributes['ignoreAttributes'], $attributes['keepRequestMethod']);`
`67`	`64`	`if ($ignoreAttributes) {`
`68`		`- $attributes = array_diff_key($attributes, array_flip($ignoreAttributes));`
	`65`	`+ $attributes = \array_diff_key($attributes, \array_flip($ignoreAttributes));`
`69`	`66`	`}`
`70`	`67`	`}`
`71`	`68`