vendor/symfony/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/vendor/symfony/src/Symfony/Component/Security/Http/RememberMe/AbstractRememberMeServices.php Sat Sep 24 15:40:41 2011 +0200
@@ -0,0 +1,296 @@
+<?php
+
+namespace Symfony\Component\Security\Http\RememberMe;
+
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Core\User\UserInterface;
+use Symfony\Component\Security\Core\Authentication\Token\RememberMeToken;
+use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
+use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\CookieTheftException;
+use Symfony\Component\Security\Core\User\UserProviderInterface;
+use Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Cookie;
+use Symfony\Component\HttpKernel\Log\LoggerInterface;
+
+/*
+ * 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.
+ */
+
+/**
+ * Base class implementing the RememberMeServicesInterface
+ *
+ * @author Johannes M. Schmitt <schmittjoh@gmail.com>
+ */
+abstract class AbstractRememberMeServices implements RememberMeServicesInterface, LogoutHandlerInterface
+{
+ const COOKIE_DELIMITER = ':';
+
+ protected $logger;
+ protected $options;
+ private $providerKey;
+ private $key;
+ private $userProviders;
+
+ /**
+ * Constructor
+ *
+ * @param array $userProviders
+ * @param string $key
+ * @param string $providerKey
+ * @param array $options
+ * @param LoggerInterface $logger
+ */
+ public function __construct(array $userProviders, $key, $providerKey, array $options = array(), LoggerInterface $logger = null)
+ {
+ if (empty($key)) {
+ throw new \InvalidArgumentException('$key must not be empty.');
+ }
+ if (empty($providerKey)) {
+ throw new \InvalidArgumentException('$providerKey must not be empty.');
+ }
+ if (0 === count($userProviders)) {
+ throw new \InvalidArgumentException('You must provide at least one user provider.');
+ }
+
+ $this->userProviders = $userProviders;
+ $this->key = $key;
+ $this->providerKey = $providerKey;
+ $this->options = $options;
+ $this->logger = $logger;
+ }
+
+ /**
+ * Returns the parameter that is used for checking whether remember-me
+ * services have been requested.
+ *
+ * @return string
+ */
+ public function getRememberMeParameter()
+ {
+ return $this->options['remember_me_parameter'];
+ }
+
+ public function getKey()
+ {
+ return $this->key;
+ }
+
+ /**
+ * Implementation of RememberMeServicesInterface. Detects whether a remember-me
+ * cookie was set, decodes it, and hands it to subclasses for further processing.
+ *
+ * @param Request $request
+ * @return TokenInterface
+ */
+ public final function autoLogin(Request $request)
+ {
+ if (null === $cookie = $request->cookies->get($this->options['name'])) {
+ return;
+ }
+
+ if (null !== $this->logger) {
+ $this->logger->debug('Remember-me cookie detected.');
+ }
+
+ $cookieParts = $this->decodeCookie($cookie);
+
+ try {
+ $user = $this->processAutoLoginCookie($cookieParts, $request);
+
+ if (!$user instanceof UserInterface) {
+ throw new \RuntimeException('processAutoLoginCookie() must return a UserInterface implementation.');
+ }
+
+ if (null !== $this->logger) {
+ $this->logger->info('Remember-me cookie accepted.');
+ }
+
+ return new RememberMeToken($user, $this->providerKey, $this->key);
+ } catch (CookieTheftException $theft) {
+ $this->cancelCookie($request);
+
+ throw $theft;
+ } catch (UsernameNotFoundException $notFound) {
+ if (null !== $this->logger) {
+ $this->logger->info('User for remember-me cookie not found.');
+ }
+ } catch (UnsupportedUserException $unSupported) {
+ if (null !== $this->logger) {
+ $this->logger->warn('User class for remember-me cookie not supported.');
+ }
+ } catch (AuthenticationException $invalid) {
+ if (null !== $this->logger) {
+ $this->logger->debug('Remember-Me authentication failed: '.$invalid->getMessage());
+ }
+ }
+
+ $this->cancelCookie($request);
+
+ return null;
+ }
+
+ /**
+ * Implementation for LogoutHandlerInterface. Deletes the cookie.
+ *
+ * @param Request $request
+ * @param Response $response
+ * @param TokenInterface $token
+ * @return void
+ */
+ public function logout(Request $request, Response $response, TokenInterface $token)
+ {
+ $this->cancelCookie($request);
+ }
+
+ /**
+ * Implementation for RememberMeServicesInterface. Deletes the cookie when
+ * an attempted authentication fails.
+ *
+ * @param Request $request
+ * @return void
+ */
+ public final function loginFail(Request $request)
+ {
+ $this->cancelCookie($request);
+ $this->onLoginFail($request);
+ }
+
+ /**
+ * Implementation for RememberMeServicesInterface. This is called when an
+ * authentication is successful.
+ *
+ * @param Request $request
+ * @param Response $response
+ * @param TokenInterface $token The token that resulted in a successful authentication
+ * @return void
+ */
+ public final function loginSuccess(Request $request, Response $response, TokenInterface $token)
+ {
+ if (!$token->getUser() instanceof UserInterface) {
+ if (null !== $this->logger) {
+ $this->logger->debug('Remember-me ignores token since it does not contain an UserInterface implementation.');
+ }
+
+ return;
+ }
+
+ if (!$this->isRememberMeRequested($request)) {
+ if (null !== $this->logger) {
+ $this->logger->debug('Remember-me was not requested.');
+ }
+
+ return;
+ }
+
+ if (null !== $this->logger) {
+ $this->logger->debug('Remember-me was requested; setting cookie.');
+ }
+
+ $this->onLoginSuccess($request, $response, $token);
+ }
+
+ /**
+ * Subclasses should validate the cookie and do any additional processing
+ * that is required. This is called from autoLogin().
+ *
+ * @param array $cookieParts
+ * @param Request $request
+ * @return TokenInterface
+ */
+ abstract protected function processAutoLoginCookie(array $cookieParts, Request $request);
+
+ protected function onLoginFail(Request $request)
+ {
+ }
+
+ /**
+ * This is called after a user has been logged in successfully, and has
+ * requested remember-me capabilities. The implementation usually sets a
+ * cookie and possibly stores a persistent record of it.
+ *
+ * @param Request $request
+ * @param Response $response
+ * @param TokenInterface $token
+ * @return void
+ */
+ abstract protected function onLoginSuccess(Request $request, Response $response, TokenInterface $token);
+
+ protected final function getUserProvider($class)
+ {
+ foreach ($this->userProviders as $provider) {
+ if ($provider->supportsClass($class)) {
+ return $provider;
+ }
+ }
+
+ throw new UnsupportedUserException(sprintf('There is no user provider that supports class "%s".', $class));
+ }
+
+ /**
+ * Decodes the raw cookie value
+ *
+ * @param string $rawCookie
+ * @return array
+ */
+ protected function decodeCookie($rawCookie)
+ {
+ return explode(self::COOKIE_DELIMITER, base64_decode($rawCookie));
+ }
+
+ /**
+ * Encodes the cookie parts
+ *
+ * @param array $cookieParts
+ * @return string
+ */
+ protected function encodeCookie(array $cookieParts)
+ {
+ return base64_encode(implode(self::COOKIE_DELIMITER, $cookieParts));
+ }
+
+ /**
+ * Deletes the remember-me cookie
+ *
+ * @param Request $request
+ * @return void
+ */
+ protected function cancelCookie(Request $request)
+ {
+ if (null !== $this->logger) {
+ $this->logger->debug(sprintf('Clearing remember-me cookie "%s"', $this->options['name']));
+ }
+
+ $request->attributes->set(self::COOKIE_ATTR_NAME, new Cookie($this->options['name'], null, 1, $this->options['path'], $this->options['domain']));
+ }
+
+ /**
+ * Checks whether remember-me capabilities where requested
+ *
+ * @param Request $request
+ * @return Boolean
+ */
+ protected function isRememberMeRequested(Request $request)
+ {
+ if (true === $this->options['always_remember_me']) {
+ return true;
+ }
+
+ $parameter = $request->request->get($this->options['remember_me_parameter'], null, true);
+
+ if ($parameter === null && null !== $this->logger) {
+ $this->logger->debug(sprintf('Did not send remember-me cookie (remember-me parameter "%s" was not sent).', $this->options['remember_me_parameter']));
+ }
+
+ return $parameter === 'true' || $parameter === 'on' || $parameter === '1' || $parameter === 'yes';
+ }
+}