[Security] allowed class names to be passed as an argument to EncoderFactoryInterface::getEncoder()

fabpot · fabpot · commit 0b8b76bfef26 · 2012-06-18T08:12:50.000+02:00
diff --git a/src/Symfony/Component/Security/CHANGELOG.md b/src/Symfony/Component/Security/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 2.1.0
 -----
 
+ * EncoderFactoryInterface::getEncoder() can now also take a class name as an argument
  * allow switching to the user that is already impersonated
  * added support for the remember_me parameter in the query
  * added AccessMapInterface
diff --git a/src/Symfony/Component/Security/Core/Encoder/EncoderFactory.php b/src/Symfony/Component/Security/Core/Encoder/EncoderFactory.php
@@ -30,10 +30,10 @@ public function __construct(array $encoders)
     /**
      * {@inheritDoc}
      */
-    public function getEncoder(UserInterface $user)
+    public function getEncoder($user)
     {
         foreach ($this->encoders as $class => $encoder) {
-            if (!$user instanceof $class) {
+            if ((is_object($user) && !$user instanceof $class) || (!is_subclass_of($user, $class) && $user != $class)) {
                 continue;
             }
 
@@ -44,7 +44,7 @@ public function getEncoder(UserInterface $user)
             return $this->encoders[$class];
         }
 
-        throw new \RuntimeException(sprintf('No encoder has been configured for account "%s".', get_class($user)));
+        throw new \RuntimeException(sprintf('No encoder has been configured for account "%s".', is_object($class) ? get_class($user) : $class));
     }
 
     /**
diff --git a/src/Symfony/Component/Security/Core/Encoder/EncoderFactoryInterface.php b/src/Symfony/Component/Security/Core/Encoder/EncoderFactoryInterface.php
@@ -23,9 +23,11 @@ interface EncoderFactoryInterface
     /**
      * Returns the password encoder to use for the given account.
      *
-     * @param UserInterface $user
+     * @param UserInterface|string $user A UserInterface instance of a class name
      *
-     * @return PasswordEncoderInterface never null
+     * @return PasswordEncoderInterface
+     *
+     * @throws \RuntimeException when no password encoder could be found for the user
      */
-    function getEncoder(UserInterface $user);
+    function getEncoder($user);
 }
diff --git a/src/Symfony/Component/Security/Tests/Core/Encoder/EncoderFactoryTest.php b/src/Symfony/Component/Security/Tests/Core/Encoder/EncoderFactoryTest.php
@@ -13,6 +13,7 @@
 
 use Symfony\Component\Security\Core\Encoder\MessageDigestPasswordEncoder;
 use Symfony\Component\Security\Core\Encoder\EncoderFactory;
+use Symfony\Component\Security\Core\User\User;
 
 class EncoderFactoryTest extends \PHPUnit_Framework_TestCase
 {
@@ -37,7 +38,25 @@ public function testGetEncoderWithService()
 
         $encoder = $factory->getEncoder($this->getMock('Symfony\Component\Security\Core\User\UserInterface'));
         $expectedEncoder = new MessageDigestPasswordEncoder('sha1');
+        $this->assertEquals($expectedEncoder->encodePassword('foo', ''), $encoder->encodePassword('foo', ''));
+
+        $encoder = $factory->getEncoder(new User('user', 'pass'));
+        $expectedEncoder = new MessageDigestPasswordEncoder('sha1');
+        $this->assertEquals($expectedEncoder->encodePassword('foo', ''), $encoder->encodePassword('foo', ''));
+    }
+
+    public function testGetEncoderWithClassName()
+    {
+        $factory = new EncoderFactory(array(
+            'Symfony\Component\Security\Core\User\UserInterface' => new MessageDigestPasswordEncoder('sha1'),
+        ));
 
+        $encoder = $factory->getEncoder('Symfony\Component\Security\Core\User\UserInterface');
+        $expectedEncoder = new MessageDigestPasswordEncoder('sha1');
+        $this->assertEquals($expectedEncoder->encodePassword('foo', ''), $encoder->encodePassword('foo', ''));
+
+        $encoder = $factory->getEncoder('Symfony\Component\Security\Core\User\User');
+        $expectedEncoder = new MessageDigestPasswordEncoder('sha1');
         $this->assertEquals($expectedEncoder->encodePassword('foo', ''), $encoder->encodePassword('foo', ''));
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -30,10 +30,10 @@ public function __construct(array $encoders)`
`30`	`30`	`/**`
`31`	`31`	`* {@inheritDoc}`
`32`	`32`	`*/`
`33`		`- public function getEncoder(UserInterface $user)`
	`33`	`+ public function getEncoder($user)`
`34`	`34`	`{`
`35`	`35`	`foreach ($this->encoders as $class => $encoder) {`
`36`		`- if (!$user instanceof $class) {`
	`36`	`+ if ((is_object($user) && !$user instanceof $class) \|\| (!is_subclass_of($user, $class) && $user != $class)) {`
`37`	`37`	`continue;`
`38`	`38`	`}`
`39`	`39`
`@@ -44,7 +44,7 @@ public function getEncoder(UserInterface $user)`
`44`	`44`	`return $this->encoders[$class];`
`45`	`45`	`}`
`46`	`46`
`47`		`- throw new \RuntimeException(sprintf('No encoder has been configured for account "%s".', get_class($user)));`
	`47`	`+ throw new \RuntimeException(sprintf('No encoder has been configured for account "%s".', is_object($class) ? get_class($user) : $class));`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,11 @@ interface EncoderFactoryInterface`
`23`	`23`	`/**`
`24`	`24`	`* Returns the password encoder to use for the given account.`
`25`	`25`	`*`
`26`		`- * @param UserInterface $user`
	`26`	`+ * @param UserInterface\|string $user A UserInterface instance of a class name`
`27`	`27`	`*`
`28`		`- * @return PasswordEncoderInterface never null`
	`28`	`+ * @return PasswordEncoderInterface`
	`29`	`+ *`
	`30`	`+ * @throws \RuntimeException when no password encoder could be found for the user`
`29`	`31`	`*/`
`30`		`- function getEncoder(UserInterface $user);`
	`32`	`+ function getEncoder($user);`
`31`	`33`	`}`