-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[SecurityBundle] Add a FirewallConfigRegistry service as main entry point #20591
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
119 changes: 119 additions & 0 deletions
119
src/Symfony/Bundle/SecurityBundle/Security/FirewallConfigRegistry.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,119 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Bundle\SecurityBundle\Security; | ||
|
||
use Symfony\Component\HttpFoundation\Request; | ||
use Symfony\Component\HttpFoundation\RequestMatcher; | ||
use Symfony\Component\HttpFoundation\RequestStack; | ||
|
||
/** | ||
* Stores firewall config objects. | ||
* | ||
* @author Maxime Steinhausser <maxime.steinhausser@gmail.com> | ||
*/ | ||
class FirewallConfigRegistry | ||
{ | ||
private $firewallConfigs; | ||
private $requestStack; | ||
private $requestMatchers; | ||
|
||
/** | ||
* @param FirewallConfig[] $firewallConfigs | ||
* @param RequestMatcher[] $requestMatchers Indexed by firewall name | ||
* @param RequestStack|null $requestStack To get the current firewall config | ||
*/ | ||
public function __construct(array $firewallConfigs = array(), array $requestMatchers = array(), RequestStack $requestStack = null) | ||
{ | ||
$this->firewallConfigs = $firewallConfigs; | ||
$this->requestStack = $requestStack; | ||
$this->requestMatchers = $requestMatchers; | ||
} | ||
|
||
/** | ||
* @param string $name The firewall name | ||
* | ||
* @return FirewallConfig|null | ||
*/ | ||
public function get($name) | ||
{ | ||
foreach ($this->firewallConfigs as $config) { | ||
if ($config->getName() === $name) { | ||
return $config; | ||
} | ||
} | ||
} | ||
|
||
/** | ||
* @return FirewallConfig|null | ||
*/ | ||
public function current() | ||
{ | ||
if (!$this->requestStack) { | ||
throw new \LogicException('Unable to get current firewall config without a RequestStack.'); | ||
} | ||
|
||
return $this->fromRequest($this->requestStack->getCurrentRequest()); | ||
} | ||
|
||
/** | ||
* @param Request $request | ||
* | ||
* @return FirewallConfig|null | ||
*/ | ||
public function fromRequest(Request $request) | ||
{ | ||
foreach ($this->firewallConfigs as $config) { | ||
$requestMatcher = $this->getRequestMatcher($config); | ||
if (null === $requestMatcher || $requestMatcher->matches($request)) { | ||
return $config; | ||
} | ||
} | ||
} | ||
|
||
/** | ||
* @return FirewallConfig[] | ||
*/ | ||
public function all() | ||
{ | ||
return $this->firewallConfigs; | ||
} | ||
|
||
/** | ||
* @return FirewallConfig[] | ||
*/ | ||
public function inContext($context) | ||
{ | ||
return array_filter($this->firewallConfigs, function (FirewallConfig $config) use ($context) { | ||
return $context === $config->getContext(); | ||
}); | ||
} | ||
|
||
/** | ||
* @param FirewallConfig $config | ||
* | ||
* @return RequestMatcher|null | ||
*/ | ||
private function getRequestMatcher(FirewallConfig $config) | ||
{ | ||
if (empty($config->getRequestMatcher())) { | ||
return; | ||
} | ||
|
||
$firewallName = $config->getName(); | ||
|
||
if (!isset($this->requestMatchers[$firewallName])) { | ||
throw new \LogicException(sprintf('Request matcher not found for "%s" firewall.', $firewallName)); | ||
} | ||
|
||
return $this->requestMatchers[$firewallName]; | ||
} | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: this would be replaced by
if (null === $config->getRequestMatcher()) {
if #20589 is mergedThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In case of this one is considered before #20589, I think it should be
if (!$config->getRequestMatcher())
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I prefer
empty
which is semantically better IMHO.