8000 [SecurityBundle][Routing] Add `LogoutRouteLoader` · symfony/symfony@10097af · GitHub
[go: up one dir, main page]
Skip to content

Commit 10097af

Browse files
MatTheCatMatTheCat
committed
[SecurityBundle][Routing] Add LogoutRouteLoader 
1 parent d6d233b commit 10097af

File tree

5 files changed

+125
-0
lines changed

5 files changed

+125
-0
lines changed

‎src/Symfony/Bundle/SecurityBundle/CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ CHANGELOG
88
* Allow an array of `pattern` in firewall configuration
99
* Add `$badges` argument to `Security::login`
1010
* Deprecate the `require_previous_session` config option. Setting it has no effect anymore
11+
* Add `LogoutRouteLoader`
1112

1213
6.3
1314
---

‎src/Symfony/Bundle/SecurityBundle/DependencyInjection/SecurityExtension.php

+20
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
use Symfony\Component\PasswordHasher\Hasher\Pbkdf2PasswordHasher;
5050
use Symfony\Component\PasswordHasher\Hasher\PlaintextPasswordHasher;
5151
use Symfony\Component\PasswordHasher\Hasher\SodiumPasswordHasher;
52+
use Symfony\Component\Routing\Loader\ContainerLoader;
5253
use Symfony\Component\Security\Core\Authorization\Strategy\AffirmativeStrategy;
5354
use Symfony\Component\Security\Core\Authorization\Strategy\ConsensusStrategy;
5455
use Symfony\Component\Security\Core\Authorization\Strategy\PriorityStrategy;
@@ -170,6 +171,13 @@ public function load(array $configs, ContainerBuilder $container)
170171
}
171172

172173
$this->createFirewalls($config, $container);
174+
175+
if ($container::willBeAvailable('symfony/routing', ContainerLoader::class, ['symfony/security/bundle'])) {
176+
$this->createLogoutPathsParameter($config['firewalls'] ?? [], $container);
177+
} else {
178+
$container->removeDefinition('security.route_loader.logout');
179+
}
180+
173181
$this->createAuthorization($config, $container);
174182
$this->createRoleHierarchy($config, $container);
175183

@@ -1091,4 +1099,16 @@ private function getSortedFactories(): array
10911099

10921100
return $this->sortedFactories;
10931101
}
1102+
1103+
private function createLogoutPathsParameter(array $firewallsConfig, ContainerBuilder $container): void
1104+
{
1105+
$logoutPaths = [];
1106+
foreach ($firewallsConfig as $name => $config) {
1107+
if ($logoutPath = $config['logout']['path'] ?? null) {
1108+
$logoutPaths[$name] = $logoutPath;
1109+
}
1110+
}
1111+
1112+
$container->setParameter('security.logout_paths', $logoutPaths);
1113+
}
10941114
}

‎src/Symfony/Bundle/SecurityBundle/Resources/config/security.php

+8
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
use Symfony\Bundle\SecurityBundle\CacheWarmer\ExpressionCacheWarmer;
1515
use Symfony\Bundle\SecurityBundle\EventListener\FirewallListener;
16+
use Symfony\Bundle\SecurityBundle\Routing\LogoutRouteLoader;
1617
use Symfony\Bundle\SecurityBundle\Security;
1718
use Symfony\Bundle\SecurityBundle\Security\FirewallConfig;
1819
use Symfony\Bundle\SecurityBundle\Security\FirewallContext;
@@ -229,6 +230,13 @@
229230
service('security.token_storage')->nullOnInvalid(),
230231
])
231232

233+
->set('security.route_loader.logout', LogoutRouteLoader::class)
234+
->args([
235+
'%security.logout_paths%',
236+
'security.logout_paths',
237+
])
238+
->tag('routing.route_loader')
239+
232240
// Provisioning
233241
->set('security.user.provider.missing', MissingUserProvider::class)
234242
->abstract()

‎src/Symfony/Bundle/SecurityBundle/Routing/LogoutRouteLoader.php

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php
2+
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+
*/
11+
12+
namespace Symfony\Bundle\SecurityBundle\Routing;
13+
14+
use Symfony\Component\DependencyInjection\Config\ContainerParametersResource;
15+
use Symfony\Component\Routing\Route;
16+
use Symfony\Component\Routing\RouteCollection;
17+
18+
class LogoutRouteLoader
19+
{
20+
/**
21+
* @param iterable<string, string> $logoutPaths Logout paths indexed by the corresponding firewall name
22+
* @param string $parameterName Name of the container parameter containing {@see $logoutPaths}' value
23+
*/
24+
public function __construct(
25+
private readonly iterable $logoutPaths,
26+
private readonly string $parameterName,
27+
) {
28+
}
29+
30+
public function __invoke(): RouteCollection
31+
{
32+
$collection = new RouteCollection();
33+
$collection->addResource(new ContainerParametersResource([$this->parameterName => $this->logoutPaths]));
34+
35+
$routeNames = [];
36+
foreach ($this->logoutPaths as $firewallName => $logoutPath) {
37+
$routeName = '_logout_'.$firewallName;
38+
39+
if (isset($routeNames[$logoutPath])) {
40+
$collection->addAlias($routeNames[$logoutPath], $routeName);
41+
} else {
42+
$routeNames[$logoutPath] = $routeName;
43+
}
44+
45+
$collection->add($routeName, new Route($logoutPath));
46+
}
47+
48+
return $collection;
49+
}
50+
}

‎src/Symfony/Bundle/SecurityBundle/Tests/Routing/LogoutRouteLoaderTest.php

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<?php
2+
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+
*/
11+
12+
namespace Symfony\Bundle\SecurityBundle\Tests\Routing;
13+
14+
use PHPUnit\Framework\TestCase;
15+
use Symfony\Bundle\SecurityBundle\Routing\LogoutRouteLoader;
16+
use Symfony\Bundle\SecurityBundle\Security\FirewallConfig;
17+
use Symfony\Component\DependencyInjection\Config\ContainerParametersResource;
18+
use Symfony\Component\Routing\Route;
19+
use Symfony\Component\Routing\RouteCollection;
20+
21+
class LogoutRouteLoaderTest extends TestCase
22+
{
23+
public function testLoad()
24+
{
25+
$logoutPaths = [
26+
'main' => '/logout',
27+
'admin' => '/logout',
28+
];
29+
30+
$loader = new LogoutRouteLoader($logoutPaths, 'parameterName');
31+
$collection = $loader();
32+
33+
self::assertInstanceOf(RouteCollection::class, $collection);
34+
self::assertCount(1, $collection);
35+
self::assertEquals(new Route('/logout'), $collection->get('_logout_main'));
36+
self::assertCount(1, $collection->getAliases());
37+
self::assertEquals('_logout_admin', $collection->getAlias('_logout_main')->getId());
38+
39+
$resources = $collection->getResources();
40+
self::assertCount(1, $resources);
41+
42+
$resource = reset($resources);
43+
self::assertInstanceOf(ContainerParametersResource::class, $resource);
44+
self::assertSame(['parameterName' => $logoutPaths], $resource->getParameters());
45+
}
46+
}

0 commit comments

Comments
 (0)
0