123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214 |
- <?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\DependencyInjection\Security\Factory;
- use Symfony\Component\Config\Definition\Builder\NodeDefinition;
- use Symfony\Component\DependencyInjection\ContainerBuilder;
- use Symfony\Component\DependencyInjection\DefinitionDecorator;
- use Symfony\Component\DependencyInjection\Reference;
- /**
- * AbstractFactory is the base class for all classes inheriting from
- * AbstractAuthenticationListener.
- *
- * @author Fabien Potencier <fabien@symfony.com>
- * @author Lukas Kahwe Smith <smith@pooteeweet.org>
- * @author Johannes M. Schmitt <schmittjoh@gmail.com>
- */
- abstract class AbstractFactory implements SecurityFactoryInterface
- {
- protected $options = array(
- 'check_path' => '/login_check',
- 'use_forward' => false,
- 'require_previous_session' => true,
- );
- protected $defaultSuccessHandlerOptions = array(
- 'always_use_default_target_path' => false,
- 'default_target_path' => '/',
- 'login_path' => '/login',
- 'target_path_parameter' => '_target_path',
- 'use_referer' => false,
- );
- protected $defaultFailureHandlerOptions = array(
- 'failure_path' => null,
- 'failure_forward' => false,
- 'login_path' => '/login',
- 'failure_path_parameter' => '_failure_path',
- );
- public function create(ContainerBuilder $container, $id, $config, $userProviderId, $defaultEntryPointId)
- {
- // authentication provider
- $authProviderId = $this->createAuthProvider($container, $id, $config, $userProviderId);
- // authentication listener
- $listenerId = $this->createListener($container, $id, $config, $userProviderId);
- // add remember-me aware tag if requested
- if ($this->isRememberMeAware($config)) {
- $container
- ->getDefinition($listenerId)
- ->addTag('security.remember_me_aware', array('id' => $id, 'provider' => $userProviderId))
- ;
- }
- // create entry point if applicable (optional)
- $entryPointId = $this->createEntryPoint($container, $id, $config, $defaultEntryPointId);
- return array($authProviderId, $listenerId, $entryPointId);
- }
- public function addConfiguration(NodeDefinition $node)
- {
- $builder = $node->children();
- $builder
- ->scalarNode('provider')->end()
- ->booleanNode('remember_me')->defaultTrue()->end()
- ->scalarNode('success_handler')->end()
- ->scalarNode('failure_handler')->end()
- ;
- foreach (array_merge($this->options, $this->defaultSuccessHandlerOptions, $this->defaultFailureHandlerOptions) as $name => $default) {
- if (\is_bool($default)) {
- $builder->booleanNode($name)->defaultValue($default);
- } else {
- $builder->scalarNode($name)->defaultValue($default);
- }
- }
- }
- final public function addOption($name, $default = null)
- {
- $this->options[$name] = $default;
- }
- /**
- * Subclasses must return the id of a service which implements the
- * AuthenticationProviderInterface.
- *
- * @param ContainerBuilder $container
- * @param string $id The unique id of the firewall
- * @param array $config The options array for this listener
- * @param string $userProviderId The id of the user provider
- *
- * @return string never null, the id of the authentication provider
- */
- abstract protected function createAuthProvider(ContainerBuilder $container, $id, $config, $userProviderId);
- /**
- * Subclasses must return the id of the abstract listener template.
- *
- * Listener definitions should inherit from the AbstractAuthenticationListener
- * like this:
- *
- * <service id="my.listener.id"
- * class="My\Concrete\Classname"
- * parent="security.authentication.listener.abstract"
- * abstract="true" />
- *
- * In the above case, this method would return "my.listener.id".
- *
- * @return string
- */
- abstract protected function getListenerId();
- /**
- * Subclasses may create an entry point of their as they see fit. The
- * default implementation does not change the default entry point.
- *
- * @param ContainerBuilder $container
- * @param string $id
- * @param array $config
- * @param string $defaultEntryPointId
- *
- * @return string the entry point id
- */
- protected function createEntryPoint($container, $id, $config, $defaultEntryPointId)
- {
- return $defaultEntryPointId;
- }
- /**
- * Subclasses may disable remember-me features for the listener, by
- * always returning false from this method.
- *
- * @return bool Whether a possibly configured RememberMeServices should be set for this listener
- */
- protected function isRememberMeAware($config)
- {
- return $config['remember_me'];
- }
- protected function createListener($container, $id, $config, $userProvider)
- {
- $listenerId = $this->getListenerId();
- $listener = new DefinitionDecorator($listenerId);
- $listener->replaceArgument(4, $id);
- $listener->replaceArgument(5, new Reference($this->createAuthenticationSuccessHandler($container, $id, $config)));
- $listener->replaceArgument(6, new Reference($this->createAuthenticationFailureHandler($container, $id, $config)));
- $listener->replaceArgument(7, array_intersect_key($config, $this->options));
- $listenerId .= '.'.$id;
- $container->setDefinition($listenerId, $listener);
- return $listenerId;
- }
- protected function createAuthenticationSuccessHandler($container, $id, $config)
- {
- $successHandlerId = $this->getSuccessHandlerId($id);
- $options = array_intersect_key($config, $this->defaultSuccessHandlerOptions);
- if (isset($config['success_handler'])) {
- $successHandler = $container->setDefinition($successHandlerId, new DefinitionDecorator('security.authentication.custom_success_handler'));
- $successHandler->replaceArgument(0, new Reference($config['success_handler']));
- $successHandler->replaceArgument(1, $options);
- $successHandler->replaceArgument(2, $id);
- } else {
- $successHandler = $container->setDefinition($successHandlerId, new DefinitionDecorator('security.authentication.success_handler'));
- $successHandler->addMethodCall('setOptions', array($options));
- $successHandler->addMethodCall('setProviderKey', array($id));
- }
- return $successHandlerId;
- }
- protected function createAuthenticationFailureHandler($container, $id, $config)
- {
- $id = $this->getFailureHandlerId($id);
- $options = array_intersect_key($config, $this->defaultFailureHandlerOptions);
- if (isset($config['failure_handler'])) {
- $failureHandler = $container->setDefinition($id, new DefinitionDecorator('security.authentication.custom_failure_handler'));
- $failureHandler->replaceArgument(0, new Reference($config['failure_handler']));
- $failureHandler->replaceArgument(1, $options);
- } else {
- $failureHandler = $container->setDefinition($id, new DefinitionDecorator('security.authentication.failure_handler'));
- $failureHandler->addMethodCall('setOptions', array($options));
- }
- return $id;
- }
- protected function getSuccessHandlerId($id)
- {
- return 'security.authentication.success_handler.'.$id.'.'.str_replace('-', '_', $this->getKey());
- }
- protected function getFailureHandlerId($id)
- {
- return 'security.authentication.failure_handler.'.$id.'.'.str_replace('-', '_', $this->getKey());
- }
- }
|