Add the ability to configure if the redirection is permanent or not

sroze · sroze · commit 859bc4f90e2f · 2017-11-24T12:44:56.000Z
diff --git a/src/Symfony/Component/Routing/Loader/LoaderHelper.php b/src/Symfony/Component/Routing/Loader/LoaderHelper.php
@@ -18,7 +18,7 @@
  */
 trait LoaderHelper
 {
-    private function redirectToDefaults(string $redirect) : array
+    private function redirectToDefaults(string $redirect, bool $permanent = false): array
     {
         if ($this->looksLikeUrl($redirect)) {
             $defaults['_controller'] = 'Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction';
@@ -28,12 +28,16 @@ private function redirectToDefaults(string $redirect) : array
             $defaults['route'] = $redirect;
         }
 
+        if ($permanent) {
+            $defaults['permanent'] = true;
+        }
+
         return $defaults;
     }
 
-    private function looksLikeUrl(string $urlOrRouteName) : bool
+    private function looksLikeUrl(string $urlOrRouteName): bool
     {
-        foreach (['/', '//', 'http://', 'https://'] as $pattern) {
+        foreach (array('/', '//', 'http://', 'https://') as $pattern) {
             if (substr($urlOrRouteName, 0, strlen($pattern)) == $pattern) {
                 return true;
             }
diff --git a/src/Symfony/Component/Routing/Loader/XmlFileLoader.php b/src/Symfony/Component/Routing/Loader/XmlFileLoader.php
@@ -242,7 +242,7 @@ private function parseConfigs(\DOMElement $node, $path)
         }
 
         if ($redirectTo = $node->getAttribute('redirect-to')) {
-            $defaults += $this->redirectToDefaults($redirectTo);
+            $defaults += $this->redirectToDefaults($redirectTo, $node->getAttribute('redirect-permanent'));
         }
 
         return array($defaults, $requirements, $options, $condition);
diff --git a/src/Symfony/Component/Routing/Loader/YamlFileLoader.php b/src/Symfony/Component/Routing/Loader/YamlFileLoader.php
@@ -29,7 +29,7 @@ class YamlFileLoader extends FileLoader
     use LoaderHelper;
 
     private static $availableKeys = array(
-        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'redirect_to',
+        'resource', 'type', 'prefix', 'path', 'host', 'schemes', 'methods', 'defaults', 'requirements', 'options', 'condition', 'controller', 'redirect_to', 'redirect_permanent',
     );
     private $yamlParser;
 
@@ -118,7 +118,7 @@ protected function parseRoute(RouteCollection $collection, $name, array $config,
         $condition = isset($config['condition']) ? $config['condition'] : null;
 
         if (isset($config['redirect_to'])) {
-            $defaults += $this->redirectToDefaults($config['redirect_to']);
+            $defaults += $this->redirectToDefaults($config['redirect_to'], $config['redirect_permanent'] ?? false);
         }
 
         if (isset($config['controller'])) {
diff --git a/src/Symfony/Component/Routing/Loader/schema/routing/routing-1.0.xsd b/src/Symfony/Component/Routing/Loader/schema/routing/routing-1.0.xsd
@@ -43,6 +43,7 @@
     <xsd:attribute name="methods" type="xsd:string" />
     <xsd:attribute name="controller" type="xsd:string" />
     <xsd:attribute name="redirect-to" type="xsd:string" />
+    <xsd:attribute name="redirect-permanent" type="xsd:boolean" />
   </xsd:complexType>
 
   <xsd:complexType name="import">
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/redirect_to/routing.xml b/src/Symfony/Component/Routing/Tests/Fixtures/redirect_to/routing.xml
@@ -7,4 +7,5 @@
     <route id="app_homepage" path="/homepage" controller="AppBundle:Homepage:show" />
     <route id="app_entrypoint" path="/" redirect-to="app_homepage" />
     <route id="app_temporary_redirect" path="/temporary-home" redirect-to="/homepage" />
+    <route id="app_permanent_redirect" path="/permanent-home" redirect-to="/homepage" redirect-permanent="true" />
 </routes>
diff --git a/src/Symfony/Component/Routing/Tests/Fixtures/redirect_to/routing.yml b/src/Symfony/Component/Routing/Tests/Fixtures/redirect_to/routing.yml
@@ -9,3 +9,8 @@ app_entrypoint:
 app_temporary_redirect:
     path: /temporary-home
     redirect_to: /homepage
+
+app_permanent_redirect:
+    path: /permanent-home
+    redirect_to: /homepage
+    redirect_permanent: true
diff --git a/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/XmlFileLoaderTest.php
@@ -374,5 +374,11 @@ public function testImportWithRedirections()
         $route = $routeCollection->get('app_temporary_redirect');
         $this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));
         $this->assertSame('/homepage', $route->getDefault('path'));
+        $this->assertFalse($route->hasDefault('permanent'));
+
+        $route = $routeCollection->get('app_permanent_redirect');
+        $this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));
+        $this->assertSame('/homepage', $route->getDefault('path'));
+        $this->assertTrue($route->hasDefault('permanent'));
     }
 }
diff --git a/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/Routing/Tests/Loader/YamlFileLoaderTest.php
@@ -195,5 +195,11 @@ public function testImportWithRedirections()
         $route = $routeCollection->get('app_temporary_redirect');
         $this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));
         $this->assertSame('/homepage', $route->getDefault('path'));
+        $this->assertFalse($route->hasDefault('permanent'));
+
+        $route = $routeCollection->get('app_permanent_redirect');
+        $this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));
+        $this->assertSame('/homepage', $route->getDefault('path'));
+        $this->assertTrue($route->hasDefault('permanent'));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`*/`
`19`	`19`	`trait LoaderHelper`
`20`	`20`	`{`
`21`		`- private function redirectToDefaults(string $redirect) : array`
	`21`	`+ private function redirectToDefaults(string $redirect, bool $permanent = false): array`
`22`	`22`	`{`
`23`	`23`	`if ($this->looksLikeUrl($redirect)) {`
`24`	`24`	`$defaults['_controller'] = 'Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction';`
`@@ -28,12 +28,16 @@ private function redirectToDefaults(string $redirect) : array`
`28`	`28`	`$defaults['route'] = $redirect;`
`29`	`29`	`}`
`30`	`30`
	`31`	`+ if ($permanent) {`
	`32`	`+ $defaults['permanent'] = true;`
	`33`	`+ }`
	`34`	`+`
`31`	`35`	`return $defaults;`
`32`	`36`	`}`
`33`	`37`
`34`		`- private function looksLikeUrl(string $urlOrRouteName) : bool`
	`38`	`+ private function looksLikeUrl(string $urlOrRouteName): bool`
`35`	`39`	`{`
`36`		`- foreach (['/', '//', 'http://', 'https://'] as $pattern) {`
	`40`	`+ foreach (array('/', '//', 'http://', 'https://') as $pattern) {`
`37`	`41`	`if (substr($urlOrRouteName, 0, strlen($pattern)) == $pattern) {`
`38`	`42`	`return true;`
`39`	`43`	`}`
Original file line number	Diff line number	Diff line change
`@@ -242,7 +242,7 @@ private function parseConfigs(\DOMElement $node, $path)`
`242`	`242`	`}`
`243`	`243`
`244`	`244`	`if ($redirectTo = $node->getAttribute('redirect-to')) {`
`245`		`- $defaults += $this->redirectToDefaults($redirectTo);`
	`245`	`+ $defaults += $this->redirectToDefaults($redirectTo, $node->getAttribute('redirect-permanent'));`
`246`	`246`	`}`
`247`	`247`
`248`	`248`	`return array($defaults, $requirements, $options, $condition);`
Original file line number	Diff line number	Diff line change
`@@ -374,5 +374,11 @@ public function testImportWithRedirections()`
`374`	`374`	`$route = $routeCollection->get('app_temporary_redirect');`
`375`	`375`	`$this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));`
`376`	`376`	`$this->assertSame('/homepage', $route->getDefault('path'));`
	`377`	`+ $this->assertFalse($route->hasDefault('permanent'));`
	`378`	`+`
	`379`	`+ $route = $routeCollection->get('app_permanent_redirect');`
	`380`	`+ $this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));`
	`381`	`+ $this->assertSame('/homepage', $route->getDefault('path'));`
	`382`	`+ $this->assertTrue($route->hasDefault('permanent'));`
`377`	`383`	`}`
`378`	`384`	`}`
Original file line number	Diff line number	Diff line change
`@@ -195,5 +195,11 @@ public function testImportWithRedirections()`
`195`	`195`	`$route = $routeCollection->get('app_temporary_redirect');`
`196`	`196`	`$this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));`
`197`	`197`	`$this->assertSame('/homepage', $route->getDefault('path'));`
	`198`	`+ $this->assertFalse($route->hasDefault('permanent'));`
	`199`	`+`
	`200`	`+ $route = $routeCollection->get('app_permanent_redirect');`
	`201`	`+ $this->assertSame('Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction', $route->getDefault('_controller'));`
	`202`	`+ $this->assertSame('/homepage', $route->getDefault('path'));`
	`203`	`+ $this->assertTrue($route->hasDefault('permanent'));`
`198`	`204`	`}`
`199`	`205`	`}`