8000 Revert "bug #9601 [Routing] Remove usage of deprecated _scheme requir… · symfony/symfony@146e666 · GitHub
[go: up one dir, main page]
Skip to content

Commit 146e666

Browse files
fabpotfabpot
committed
Revert "bug #9601 [Routing] Remove usage of deprecated _scheme requirement (Danez)"
This reverts commit 0af3d19, reversing changes made to d56cc4b.
1 parent e7df0cf commit 146e666

File tree

14 files changed

+34
-219
lines changed

14 files changed

+34
-219
lines changed

‎src/Symfony/Bundle/FrameworkBundle/Tests/Routing/RedirectableUrlMatcherTest.php

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -38,30 +38,10 @@ public function testRedirectWhenNoSlash()
3838
);
3939
}
4040

41-
public function testSchemeRedirectBC()
42-
{
43-
$coll = new RouteCollection();
44-
$coll->add('foo', new Route('/foo', array(), array('_scheme' => 'https')));
45-
46-
$matcher = new RedirectableUrlMatcher($coll, $context = new RequestContext());
47-
48-
$this->assertEquals(array(
49-
'_controller' => 'Symfony\Bundle\FrameworkBundle\Controller\RedirectController::urlRedirectAction',
50-
'path' => '/foo',
51-
'permanent' => true,
52-
'scheme' => 'https',
53-
'httpPort' => $context->getHttpPort(),
54-
'httpsPort' => $context->getHttpsPort(),
55-
'_route' => 'foo',
56-
),
57-
$matcher->match('/foo')
58-
);
59-
}
60-
6141
public function testSchemeRedirect()
6242
{
6343
$coll = new RouteCollection();
64-
$coll->add('foo', new Route('/foo', array(), array(), array(), '', array('https')));
44+
$coll->add('foo', new Route('/foo', array(), array('_scheme' => 'https')));
6545

6646
$matcher = new RedirectableUrlMatcher($coll, $context = new RequestContext());
6747

‎src/Symfony/Component/Routing/Generator/Dumper/PhpGeneratorDumper.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,6 @@ private function generateDeclaredRoutes()
9292
$properties[] = $route->getRequirements();
9393
$properties[] = $compiledRoute->getTokens();
9494
$properties[] = $compiledRoute->getHostTokens();
95-
$properties[] = $route->getSchemes();
9695

9796
$routes .= sprintf(" '%s' => %s,\n", $name, str_replace("\n", '', var_export($properties, true)));
9897
}
@@ -115,9 +114,9 @@ public function generate(\$name, \$parameters = array(), \$referenceType = self:
115114
throw new RouteNotFoundException(sprintf('Unable to generate a URL for the named route "%s" as such route does not exist.', \$name));
116115
}
117116
118-
list(\$variables, \$defaults, \$requirements, \$tokens, \$hostTokens, \$requiredSchemes) = self::\$declaredRoutes[\$name];
117+
list(\$variables, \$defaults, \$requirements, \$tokens, \$hostTokens) = self::\$declaredRoutes[\$name];
119118
120-
return \$this->doGenerate(\$variables, \$defaults, \$requirements, \$tokens, \$parameters, \$name, \$referenceType, \$hostTokens, \$requiredSchemes);
119+
return \$this->doGenerate(\$variables, \$defaults, \$requirements, \$tokens, \$parameters, \$name, \$referenceType, \$hostTokens);
121120
}
122121
EOF;
123122
}

‎src/Symfony/Component/Routing/Generator/UrlGenerator.php

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -137,15 +137,15 @@ public function generate($name, $parameters = array(), $referenceType = self::AB
137137
// the Route has a cache of its own and is not recompiled as long as it does not get modified
138138
$compiledRoute = $route->compile();
139139

140-
return $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens(), $route->getSchemes());
140+
return $this->doGenerate($compiledRoute->getVariables(), $route->getDefaults(), $route->getRequirements(), $compiledRoute->getTokens(), $parameters, $name, $referenceType, $compiledRoute->getHostTokens());
141141
}
142142

143143
/**
144144
* @throws MissingMandatoryParametersException When some parameters are missing that are mandatory for the route
145145
* @throws InvalidParameterException When a parameter value for a placeholder is not correct because
146146
* it does not match the requirement
147147
*/
148-
protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens, array $requiredSchemes = array())
148+
protected function doGenerate($variables, $defaults, $requirements, $tokens, $parameters, $name, $referenceType, $hostTokens)
149149
{
150150
$variables = array_flip($variables);
151151
$mergedParams = array_replace($defaults, $this->context->getParameters(), $parameters);
@@ -204,24 +204,7 @@ protected function doGenerate($variables, $defaults, $requirements, $tokens, $pa
204204
$schemeAuthority = '';
205205
if ($host = $this->context->getHost()) {
206206
$scheme = $this->context->getScheme();
207-
208-
if ($requiredSchemes) {
209-
$schemeMatched = false;
210-
foreach ($requiredSchemes as $requiredScheme) {
211-
if ($scheme === $requiredScheme) {
212-
$schemeMatched = true;
213-
214-
break;
215-
}
216-
}
217-
218-
if (!$schemeMatched) {
219-
$referenceType = self::ABSOLUTE_URL;
220-
$scheme = current($requiredSchemes);
221-
}
222-
223-
} elseif (isset($requirements['_scheme']) && ($req = strtolower($requirements['_scheme'])) && $scheme !== $req) {
224-
// We do this for BC; to be removed if _scheme is not supported anymore
207+
if (isset($requirements['_scheme']) && ($req = strtolower($requirements['_scheme'])) && $scheme !== $req) {
225208
$referenceType = self::ABSOLUTE_URL;
226209
$scheme = $req;
227210
}

‎src/Symfony/Component/Routing/Matcher/Dumper/PhpMatcherDumper.php

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -280,15 +280,14 @@ private function compileRoute(Route $route, $name, $supportsRedirections, $paren
280280
EOF;
281281
}
282282

283-
if ($schemes = $route->getSchemes()) {
283+
if ($scheme = $route->getRequirement('_scheme')) {
284284
if (!$supportsRedirections) {
285-
throw new \LogicException('The "schemes" requirement is only supported for URL matchers that implement RedirectableUrlMatcherInterface.');
285+
throw new \LogicException('The "_scheme" requirement is only supported for URL matchers that implement RedirectableUrlMatcherInterface.');
286286
}
287-
$schemes = str_replace("\n", '', var_export(array_flip($schemes), true));
287+
288288
$code .= <<<EOF
289-
\$requiredSchemes = $schemes;
290-
if (!isset(\$requiredSchemes[\$this->context->getScheme()])) {
291-
return \$this->redirect(\$pathinfo, '$name', key(\$requiredSchemes));
289+
if (\$this->context->getScheme() !== '$scheme') {
290+
return \$this->redirect(\$pathinfo, '$name', '$scheme');
292291
}
293292
294293
@@ -306,11 +305,8 @@ private function compileRoute(Route $route, $name, $supportsRedirections, $paren
306305
}
307306
$vars[] = "array('_route' => '$name')";
308307

309-
$code .= sprintf(
310-
" return \$this->mergeDefaults(array_replace(%s), %s);\n",
311-
implode(', ', $vars),
312-
str_replace("\n", '', var_export($route->getDefaults(), true))
313-
);
308+
$code .= sprintf(" return \$this->mergeDefaults(array_replace(%s), %s);\n"
309+
, implode(', ', $vars), str_replace("\n", '', var_export($route->getDefaults(), true)));
314310

315311
} elseif ($route->getDefaults()) {
316312
$code .= sprintf(" return %s;\n", str_replace("\n", '', var_export(array_replace($route->getDefaults(), array('_route' => $name)), true)));

‎src/Symfony/Component/Routing/Matcher/RedirectableUrlMatcher.php

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,10 +51,9 @@ public function match($pathinfo)
5151
protected function handleRouteRequirements($pathinfo, $name, Route $route)
5252
{
5353
// check HTTP scheme requirement
54-
$scheme = $this->context->getScheme();
55-
$schemes = $route->getSchemes();
56-
if ($schemes && !$route->hasScheme($scheme)) {
57-
return array(self::ROUTE_MATCH, $this->redirect($pathinfo, $name, current($schemes)));
54+
$scheme = $route->getRequirement('_scheme');
55+
if ($scheme && $this->context->getScheme() !== $scheme) {
56+
return array(self::ROUTE_MATCH, $this->redirect($pathinfo, $name, $scheme));
5857
}
5958

6059
return array(self::REQUIREMENT_MATCH, null);

‎src/Symfony/Component/Routing/Matcher/TraceableUrlMatcher.php

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,11 +94,9 @@ protected function matchCollection($pathinfo, RouteCollection $routes)
9494
}
9595

9696
// check HTTP scheme requirement
97-
if ($requiredSchemes = $route->getSchemes()) {
98-
$scheme = $this->context->getScheme();
99-
100-
if (!$route->hasScheme($scheme)) {
101-
$this->addTrace(sprintf('Scheme "%s" does not match any of the required schemes ("%s"); the user will be redirected to first required scheme', $scheme, implode(', ', $requiredSchemes)), self::ROUTE_ALMOST_MATCHES, $name, $route);
97+
if ($scheme = $route->getRequirement('_scheme')) {
98+
if ($this->context->getScheme() !== $scheme) {
99+
$this->addTrace(sprintf('Scheme "%s" does not match the requirement ("%s"); the user will be redirected', $this->context->getScheme(), $scheme), self::ROUTE_ALMOST_MATCHES, $name, $route);
102100

103101
return true;
104102
}

‎src/Symfony/Component/Routing/Matcher/UrlMatcher.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -181,8 +181,8 @@ protected function getAttributes(Route $route, $name, array $attributes)
181181
protected function handleRouteRequirements($pathinfo, $name, Route $route)
182182
{
183183
// check HTTP scheme requirement
184-
$scheme = $this->context->getScheme();
185-
$status = $route->getSchemes() && !$route->hasScheme($scheme) ? self::REQUIREMENT_MISMATCH : self::REQUIREMENT_MATCH;
184+
$scheme = $route->getRequirement('_scheme');
185+
$status = $scheme && $scheme !== $this->context->getScheme() ? self::REQUIREMENT_MISMATCH : self::REQUIREMENT_MATCH;
186186

187187
return array($status, null);
188188
}

‎src/Symfony/Component/Routing/Route.php

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -241,25 +241,6 @@ public function setSchemes($schemes)
241241
return $this;
242242
}
243243

244-
/**
245-
* Checks if a scheme requirement has been set.
246-
*
247-
* @param string $scheme
248-
*
249-
* @return Boolean true if the scheme requirement exists, otherwise false
250-
*/
251-
public function hasScheme($scheme)
252-
{
253-
$scheme = strtolower($scheme);
254-
foreach ($this->schemes as $requiredScheme) {
255-
if ($scheme === $requiredScheme) {
256-
return true;
257-
}
258-
}
259-
260-
return false;
261-
}
262-
263244
/**
264245
* Returns the uppercased HTTP methods this route is restricted to.
265246
* So an empty array means that any method is allowed.

‎src/Symfony/Component/Routing/Tests/Fixtures/dumper/url_matcher2.php

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -319,19 +319,17 @@ public function match($pathinfo)
319319

320320
// secure
321321
if ($pathinfo === '/secure') {
322-
$requiredSchemes = array ( 'https' => 0,);
323-
if (!isset($requiredSchemes[$this->context->getScheme()])) {
324-
return $this->redirect($pathinfo, 'secure', key($requiredSchemes));
322+
if ($this->context->getScheme() !== 'https') {
323+
return $this->redirect($pathinfo, 'secure', 'https');
325324
}
326325

327326
return array('_route' => 'secure');
328327
}
329328

330329
// nonsecure
331330
if ($pathinfo === '/nonsecure') {
332-
$requiredSchemes = array ( 'http' => 0,);
333-
if (!isset($requiredSchemes[$this->context->getScheme()])) {
334-
return $this->redirect($pathinfo, 'nonsecure', key($requiredSchemes));
331+
if ($this->context->getScheme() !== 'http') {
332+
return $this->redirect($pathinfo, 'nonsecure', 'http');
335333
}
336334

337335
return array('_route' => 'nonsecure');

‎src/Symfony/Component/Routing/Tests/Generator/Dumper/PhpGeneratorDumperTest.php

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -114,37 +114,4 @@ public function testDumpForRouteWithDefaults()
114114

115115
$this->assertEquals($url, '/testing');
116116
}
117-
118-
public function testDumpWithSchemeRequirement()
119-
{
120-
$this->routeCollection->add('Test1', new Route('/testing', array(), array(), array(), '', array('ftp', 'https')));
121-
$this->routeCollection->add('Test2', new Route('/testing_bc', array(), array('_scheme' => 'https'))); // BC
122-
123-
file_put_contents($this->testTmpFilepath, $this->generatorDumper->dump(array('class' => 'SchemeUrlGenerator')));
124-
include ($this->testTmpFilepath);
125-
126-
$projectUrlGenerator = new \SchemeUrlGenerator(new RequestContext('/app.php'));
127-
128-
$absoluteUrl = $projectUrlGenerator->generate('Test1', array(), true);
129-
$absoluteUrlBC = $projectUrlGenerator->generate('Test2', array(), true);
130-
$relativeUrl = $projectUrlGenerator->generate('Test1', array(), false);
131-
$relativeUrlBC = $projectUrlGenerator->generate('Test2', array(), false);
132-
133-
$this->assertEquals($absoluteUrl, 'ftp://localhost/app.php/testing');
134-
$this->assertEquals($absoluteUrlBC, 'https://localhost/app.php/testing_bc');
135-
$this->assertEquals($relativeUrl, 'ftp://localhost/app.php/testing');
136-
$this->assertEquals($relativeUrlBC, 'https://localhost/app.php/testing_bc');
137-
138-
$projectUrlGenerator = new \SchemeUrlGenerator(new RequestContext('/app.php', 'GET', 'localhost', 'https'));
139-
140-
$absoluteUrl = $projectUrlGenerator->generate('Test1', array(), true);
141-
$absoluteUrlBC = $projectUrlGenerator->generate('Test2', array(), true);
142-
$relativeUrl = $projectUrlGenerator->generate('Test1', array(), false);
143-
$relativeUrlBC = $projectUrlGenerator->generate('Test2', array(), false);
144-
145-
$this->assertEquals($absoluteUrl, 'https://localhost/app.php/testing');
146-
$this->assertEquals($absoluteUrlBC, 'https://localhost/app.php/testing_bc');
147-
$this->assertEquals($relativeUrl, '/app.php/testing');
148-
$this->assertEquals($relativeUrlBC, '/app.php/testing_bc');
149-
}
150117
}

‎src/Symfony/Component/Routing/Tests/Generator/UrlGeneratorTest.php

Lines changed: 7 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -248,40 +248,22 @@ public function testRequiredParamAndEmptyPassed()
248248

249249
public function testSchemeRequirementDoesNothingIfSameCurrentScheme()
250250
{
251-
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'http'))); // BC
251+
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'http')));
252252
$this->assertEquals('/app.php/', $this->getGenerator($routes)->generate('test'));
253253

254-
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'https'))); // BC
255-
$this->assertEquals('/app.php/', $this->getGenerator($routes, array('scheme' => 'https'))->generate('test'));
256-
257-
$routes = $this->getRoutes('test', new Route('/', array(), array(), array(), '', array('http')));
258-
$this->assertEquals('/app.php/', $this->getGenerator($routes)->generate('test'));
259-
260-
$routes = $this->getRoutes('test', new Route('/', array(), array(), array(), '', array('https')));
254+
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'https')));
261255
$this->assertEquals('/app.php/', $this->getGenerator($routes, array('scheme' => 'https'))->generate('test'));
262256
}
263257

264258
public function testSchemeRequirementForcesAbsoluteUrl()
265259
{
266-
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'https'))); // BC
267-
$this->assertEquals('https://localhost/app.php/', $this->getGenerator($routes)->generate('test'));
268-
269-
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'http'))); // BC
270-
$this->assertEquals('http://localhost/app.php/', $this->getGenerator($routes, array('scheme' => 'https'))->generate('test'));
271-
272-
$routes = $this->getRoutes('test', new Route('/', array(), array(), array(), '', array('https')));
260+
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'https')));
273261
$this->assertEquals('https://localhost/app.php/', $this->getGenerator($routes)->generate('test'));
274262

275-
$routes = $this->getRoutes('test', new Route('/', array(), array(), array(), '', array('http')));
263+
$routes = $this->getRoutes('test', new Route('/', array(), array('_scheme' => 'http')));
276264
$this->assertEquals('http://localhost/app.php/', $this->getGenerator($routes, array('scheme' => 'https'))->generate('test'));
277265
}
278266

279-
public function testSchemeRequirementCreatesUrlForFirstRequiredScheme()
280-
{
281-
$routes = $this->getRoutes('test', new Route('/', array(), array(), array(), '', array('Ftp', 'https')));
282-
$this->assertEquals('ftp://localhost/app.php/', $this->getGenerator($routes)->generate('test'));
283-
}
284-
285267
public function testPathWithTwoStartingSlashes()
286268
{
287269
$routes = $this->getRoutes('test', new Route('//path-and-not-domain'));
@@ -465,27 +447,9 @@ public function testUrlWithInvalidParameterInHostInNonStrictMode()
465447
$this->assertNull($generator->generate('test', array('foo' => 'baz'), false));
466448
}
467449

468-
public function testGenerateNetworkPathBC()
469-
{
470-
$routes = $this->getRoutes('test', new Route('/{name}', array(), array('_scheme' => 'http'), array(), '{locale}.example.com'));
471-
472-
$this->assertSame('//fr.example.com/app.php/Fabien', $this->getGenerator($routes)->generate('test',
473-
array('name' =>'Fabien', 'locale' => 'fr'), UrlGeneratorInterface::NETWORK_PATH), 'network path with different host'
474-
);
475-
$this->assertSame('//fr.example.com/app.php/Fabien?query=string', $this->getGenerator($routes, array('host' => 'fr.example.com'))->generate('test',
476-
array('name' =>'Fabien', 'locale' => 'fr', 'query' => 'string'), UrlGeneratorInterface::NETWORK_PATH), 'network path although host same as context'
477-
);
478-
$this->assertSame('http://fr.example.com/app.php/Fabien', $this->getGenerator($routes, array('scheme' => 'https'))->generate('test',
479-
array('name' =>'Fabien', 'locale' => 'fr'), UrlGeneratorInterface::NETWORK_PATH), 'absolute URL because scheme requirement does not match context'
480-
);
481-
$this->assertSame('http://fr.example.com/app.php/Fabien', $this->getGenerator($routes)->generate('test',
482-
array('name' =>'Fabien', 'locale' => 'fr'), UrlGeneratorInterface::ABSOLUTE_URL), 'absolute URL with same scheme because it is requested'
483-
);
484-
}
485-
486450
public function testGenerateNetworkPath()
487451
{
488-
$routes = $this->getRoutes('test', new Route('/{name}', array(), array(), array(), '{locale}.example.com', array('http')));
452+
$routes = $this->getRoutes('test', new Route('/{name}', array(), array('_scheme' => 'http'), array(), '{locale}.example.com'));
489453

490454
$this->assertSame('//fr.example.com/app.php/Fabien', $this->getGenerator($routes)->generate('test',
491455
array('name' =>'Fabien', 'locale' => 'fr'), UrlGeneratorInterface::NETWORK_PATH), 'network path with different host'
@@ -507,8 +471,7 @@ public function testGenerateRelativePath()
507471
$routes->add('article', new Route('/{author}/{article}/'));
508472
$routes->add('comments', new Route('/{author}/{article}/comments'));
509473
$routes->add('host', new Route('/{article}', array(), array(), array(), '{author}.example.com'));
510-
$routes->add('schemeBC', new Route('/{author}', array(), array('_scheme' => 'https'))); // BC
511-
$routes->add('scheme', new Route('/{author}/blog', array(), array(), array(), '', array('https')));
474+
$routes->add('scheme', new Route('/{author}', array(), array('_scheme' => 'https')));
512475
$routes->add('unrelated', new Route('/about'));
513476

514477
$generator = $this->getGenerator($routes, array('host' => 'example.com', 'pathInfo' => '/fabien/symfony-is-great/'));
@@ -528,12 +491,9 @@ public function testGenerateRelativePath()
528491
$this->assertSame('//bernhard.example.com/app.php/forms-are-great', $generator->generate('host',
529492
array('author' =>'bernhard', 'article' => 'forms-are-great'), UrlGeneratorInterface::RELATIVE_PATH)
530493
);
531-
$this->assertSame('https://example.com/app.php/bernhard', $generator->generate('schemeBC',
494+
$this->assertSame('https://example.com/app.php/bernhard', $generator->generate('scheme',
532495
array('author' =>'bernhard'), UrlGeneratorInterface::RELATIVE_PATH)
533496
);
534-
$this->assertSame('https://example.com/app.php/bernhard/blog', $generator->generate('scheme',
535-
array('author' =>'bernhard'), UrlGeneratorInterface::RELATIVE_PATH)
536-
);
537497
$this->assertSame('../../about', $generator->generate('unrelated',
538498
array(), UrlGeneratorInterface::RELATIVE_PATH)
539499
);

0 commit comments

Comments
 (0)
0