[Security] remove deprecated features

xabbuh · xabbuh · commit be387edebdfc · 2017-05-21T11:53:58.000+02:00
diff --git a/src/Symfony/Component/Security/CHANGELOG.md b/src/Symfony/Component/Security/CHANGELOG.md
@@ -1,6 +1,16 @@
 CHANGELOG
 =========
 
+4.0.0
+-----
+
+ * The `AbstractFormLoginAuthenticator::onAuthenticationSuccess()` was removed.
+   You should implement this method yourself in your concrete authenticator.
+ * removed the `AccessDecisionManager::setVoters()` method
+ * removed the `RoleInterface`
+ * added a sixth `$context` argument to the `LogoutUrlGenerator::registerListener()`
+   method
+
 3.3.0
 -----
 
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/AbstractToken.php
@@ -11,7 +11,6 @@
 
 namespace Symfony\Component\Security\Core\Authentication\Token;
 
-use Symfony\Component\Security\Core\Role\RoleInterface;
 use Symfony\Component\Security\Core\Role\Role;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\AdvancedUserInterface;
@@ -33,7 +32,7 @@ abstract class AbstractToken implements TokenInterface
     /**
      * Constructor.
      *
-     * @param (RoleInterface|string)[] $roles An array of roles
+     * @param (Role|string)[] $roles An array of roles
      *
      * @throws \InvalidArgumentException
      */
@@ -42,8 +41,8 @@ public function __construct(array $roles = array())
         foreach ($roles as $role) {
             if (is_string($role)) {
                 $role = new Role($role);
-            } elseif (!$role instanceof RoleInterface) {
-                throw new \InvalidArgumentException(sprintf('$roles must be an array of strings, or RoleInterface instances, but got %s.', gettype($role)));
+            } elseif (!$role instanceof Role) {
+                throw new \InvalidArgumentException(sprintf('$roles must be an array of strings, or Role instances, but got %s.', gettype($role)));
             }
 
             $this->roles[] = $role;
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/PreAuthenticatedToken.php
@@ -24,10 +24,10 @@ class PreAuthenticatedToken extends AbstractToken
     /**
      * Constructor.
      *
-     * @param string|object            $user        The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string
-     * @param mixed                    $credentials The user credentials
-     * @param string                   $providerKey The provider key
-     * @param (RoleInterface|string)[] $roles       An array of roles
+     * @param string|object   $user        The user can be a UserInterface instance, or an object implementing a __toString method or the username as a regular string
+     * @param mixed           $credentials The user credentials
+     * @param string          $providerKey The provider key
+     * @param (Role|string)[] $roles       An array of roles
      */
     public function __construct($user, $credentials, $providerKey, array $roles = array())
     {
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php b/src/Symfony/Component/Security/Core/Authentication/Token/TokenInterface.php
@@ -11,7 +11,7 @@
 
 namespace Symfony\Component\Security\Core\Authentication\Token;
 
-use Symfony\Component\Security\Core\Role\RoleInterface;
+use Symfony\Component\Security\Core\Role\Role;
 
 /**
  * TokenInterface is the interface for the user authentication information.
@@ -33,7 +33,7 @@ public function __toString();
     /**
      * Returns the user roles.
      *
-     * @return RoleInterface[] An array of RoleInterface instances
+     * @return Role[] An array of Role instances
      */
     public function getRoles();
 
diff --git a/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php b/src/Symfony/Component/Security/Core/Authentication/Token/UsernamePasswordToken.php
@@ -24,10 +24,10 @@ class UsernamePasswordToken extends AbstractToken
     /**
      * Constructor.
      *
-     * @param string|object            $user        The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method
-     * @param string                   $credentials This usually is the password of the user
-     * @param string                   $providerKey The provider key
-     * @param (RoleInterface|string)[] $roles       An array of roles
+     * @param string|object   $user        The username (like a nickname, email address, etc.), or a UserInterface instance or an object implementing a __toString method
+     * @param string          $credentials This usually is the password of the user
+     * @param string          $providerKey The provider key
+     * @param (Role|string)[] $roles       An array of roles
      *
      * @throws \InvalidArgumentException
      */
diff --git a/src/Symfony/Component/Security/Core/Authorization/AccessDecisionManager.php b/src/Symfony/Component/Security/Core/Authorization/AccessDecisionManager.php
@@ -52,20 +52,6 @@ public function __construct($voters = array(), $strategy = self::STRATEGY_AFFIRM
         $this->allowIfEqualGrantedDeniedDecisions = (bool) $allowIfEqualGrantedDeniedDecisions;
     }
 
-    /**
-     * Configures the voters.
-     *
-     * @param VoterInterface[] $voters An array of VoterInterface instances
-     *
-     * @deprecated since version 3.3, to be removed in 4.0. Pass the voters to the constructor instead.
-     */
-    public function setVoters(array $voters)
-    {
-        @trigger_error(sprintf('The %s() method is deprecated since version 3.3 and will be removed in 4.0. Pass the voters to the constructor instead.', __METHOD__), E_USER_DEPRECATED);
-
-        $this->voters = $voters;
-    }
-
     /**
      * {@inheritdoc}
      */
diff --git a/src/Symfony/Component/Security/Core/Authorization/DebugAccessDecisionManager.php b/src/Symfony/Component/Security/Core/Authorization/DebugAccessDecisionManager.php
diff --git a/src/Symfony/Component/Security/Core/Authorization/TraceableAccessDecisionManager.php b/src/Symfony/Component/Security/Core/Authorization/TraceableAccessDecisionManager.php
@@ -60,23 +60,6 @@ public function decide(TokenInterface $token, array $attributes, $object = null)
         return $result;
     }
 
-    /**
-     * {@inheritdoc}
-     *
-     * @deprecated since version 3.3, to be removed in 4.0. Pass voters to the decorated AccessDecisionManager instead.
-     */
-    public function setVoters(array $voters)
-    {
-        @trigger_error(sprintf('The %s() method is deprecated since version 3.3 and will be removed in 4.0. Pass voters to the decorated AccessDecisionManager instead.', __METHOD__), E_USER_DEPRECATED);
-
-        if (!method_exists($this->manager, 'setVoters')) {
-            return;
-        }
-
-        $this->voters = $voters;
-        $this->manager->setVoters($voters);
-    }
-
     /**
      * @return string
      */
diff --git a/src/Symfony/Component/Security/Core/Authorization/Voter/RoleVoter.php b/src/Symfony/Component/Security/Core/Authorization/Voter/RoleVoter.php
@@ -12,7 +12,7 @@
 namespace Symfony\Component\Security\Core\Authorization\Voter;
 
 use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
-use Symfony\Component\Security\Core\Role\RoleInterface;
+use Symfony\Component\Security\Core\Role\Role;
 
 /**
  * RoleVoter votes if any attribute starts with a given prefix.
@@ -42,7 +42,7 @@ public function vote(TokenInterface $token, $subject, array $attributes)
         $roles = $this->extractRoles($token);
 
         foreach ($attributes as $attribute) {
-            if ($attribute instanceof RoleInterface) {
+            if ($attribute instanceof Role) {
                 $attribute = $attribute->getRole();
             }
 
diff --git a/src/Symfony/Component/Security/Core/Role/Role.php b/src/Symfony/Component/Security/Core/Role/Role.php
@@ -16,7 +16,7 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  */
-class Role implements RoleInterface
+class Role
 {
     private $role;
 
@@ -31,7 +31,9 @@ public function __construct($role)
     }
 
     /**
-     * {@inheritdoc}
+     * Returns a string representation of the role.
+     *
+     * @return string
      */
     public function getRole()
     {
diff --git a/src/Symfony/Component/Security/Core/Role/RoleHierarchyInterface.php b/src/Symfony/Component/Security/Core/Role/RoleHierarchyInterface.php
@@ -24,9 +24,9 @@ interface RoleHierarchyInterface
      * Reachable roles are the roles directly assigned but also all roles that
      * are transitively reachable from them in the role hierarchy.
      *
-     * @param RoleInterface[] $roles An array of directly assigned roles
+     * @param Role[] $roles An array of directly assigned roles
      *
-     * @return RoleInterface[] An array of all reachable roles
+     * @return Role[] An array of all reachable roles
      */
     public function getReachableRoles(array $roles);
 }
diff --git a/src/Symfony/Component/Security/Core/Role/RoleInterface.php b/src/Symfony/Component/Security/Core/Role/RoleInterface.php
diff --git a/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php b/src/Symfony/Component/Security/Guard/Authenticator/AbstractFormLoginAuthenticator.php
@@ -15,7 +15,6 @@
 use Symfony\Component\Security\Guard\AbstractGuardAuthenticator;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\Security;
 use Symfony\Component\Security\Http\Util\TargetPathTrait;
@@ -55,38 +54,6 @@ public function onAuthenticationFailure(Request $request, AuthenticationExceptio
         return new RedirectResponse($url);
     }
 
-    /**
-     * Override to change what happens after successful authentication.
-     *
-     * @param Request        $request
-     * @param TokenInterface $token
-     * @param string         $providerKey
-     *
-     * @return RedirectResponse
-     */
-    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
-    {
-        @trigger_error(sprintf('The AbstractFormLoginAuthenticator::onAuthenticationSuccess() implementation was deprecated in Symfony 3.1 and will be removed in Symfony 4.0. You should implement this method yourself in %s and remove getDefaultSuccessRedirectUrl().', get_class($this)), E_USER_DEPRECATED);
-
-        if (!method_exists($this, 'getDefaultSuccessRedirectUrl')) {
-            throw new \Exception(sprintf('You must implement onAuthenticationSuccess() or getDefaultSuccessRedirectUrl() in %s.', get_class($this)));
-        }
-
-        $targetPath = null;
-
-        // if the user hit a secure page and start() was called, this was
-        // the URL they were on, and probably where you want to redirect to
-        if ($request->getSession() instanceof SessionInterface) {
-            $targetPath = $this->getTargetPath($request->getSession(), $providerKey);
-        }
-
-        if (!$targetPath) {
-            $targetPath = $this->getDefaultSuccessRedirectUrl();
-        }
-
-        return new RedirectResponse($targetPath);
-    }
-
     public function supportsRememberMe()
     {
         return true;
diff --git a/src/Symfony/Component/Security/Guard/Tests/Authenticator/FormLoginAuthenticatorTest.php b/src/Symfony/Component/Security/Guard/Tests/Authenticator/FormLoginAuthenticatorTest.php
@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\Exception\AuthenticationException;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\UserProviderInterface;
@@ -51,59 +52,6 @@ public function testAuthenticationFailureWithSession()
         $this->assertEquals(self::LOGIN_URL, $failureResponse->getTargetUrl());
     }
 
-    /**
-     * @group legacy
-     */
-    public function testAuthenticationSuccessWithoutSession()
-    {
-        $token = $this->getMockBuilder('Symfony\\Component\\Security\\Core\\Authentication\\Token\\TokenInterface')
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $redirectResponse = $this->authenticator->onAuthenticationSuccess($this->requestWithoutSession, $token, 'providerkey');
-
-        $this->assertInstanceOf('Symfony\\Component\\HttpFoundation\\RedirectResponse', $redirectResponse);
-        $this->assertEquals(self::DEFAULT_SUCCESS_URL, $redirectResponse->getTargetUrl());
-    }
-
-    /**
-     * @group legacy
-     */
-    public function testAuthenticationSuccessWithSessionButEmpty()
-    {
-        $token = $this->getMockBuilder('Symfony\\Component\\Security\\Core\\Authentication\\Token\\TokenInterface')
-            ->disableOriginalConstructor()
-            ->getMock();
-        $this->requestWithSession->getSession()
-            ->expects($this->once())
-            ->method('get')
-            ->will($this->returnValue(null));
-
-        $redirectResponse = $this->authenticator->onAuthenticationSuccess($this->requestWithSession, $token, 'providerkey');
-
-        $this->assertInstanceOf('Symfony\\Component\\HttpFoundation\\RedirectResponse', $redirectResponse);
-        $this->assertEquals(self::DEFAULT_SUCCESS_URL, $redirectResponse->getTargetUrl());
-    }
-
-    /**
-     * @group legacy
-     */
-    public function testAuthenticationSuccessWithSessionAndTarget()
-    {
-        $token = $this->getMockBuilder('Symfony\\Component\\Security\\Core\\Authentication\\Token\\TokenInterface')
-            ->disableOriginalConstructor()
-            ->getMock();
-        $this->requestWithSession->getSession()
-            ->expects($this->once())
-            ->method('get')
-            ->will($this->returnValue(self::CUSTOM_SUCCESS_URL));
-
-        $redirectResponse = $this->authenticator->onAuthenticationSuccess($this->requestWithSession, $token, 'providerkey');
-
-        $this->assertInstanceOf('Symfony\\Component\\HttpFoundation\\RedirectResponse', $redirectResponse);
-        $this->assertEquals(self::CUSTOM_SUCCESS_URL, $redirectResponse->getTargetUrl());
-    }
-
     public function testRememberMe()
     {
         $doSupport = $this->authenticator->supportsRememberMe();
@@ -156,6 +104,10 @@ class TestFormLoginAuthenticator extends AbstractFormLoginAuthenticator
     private $loginUrl;
     private $defaultSuccessRedirectUrl;
 
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token, $providerKey)
+    {
+    }
+
     /**
      * @param mixed $defaultSuccessRedirectUrl
      *
diff --git a/src/Symfony/Component/Security/Http/Logout/LogoutUrlGenerator.php b/src/Symfony/Component/Security/Http/Logout/LogoutUrlGenerator.php

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*`
`17`	`17`	`* @author Fabien Potencier <[email protected]>`
`18`	`18`	`*/`
`19`		`-class Role implements RoleInterface`
	`19`	`+class Role`
`20`	`20`	`{`
`21`	`21`	`private $role;`
`22`	`22`
`@@ -31,7 +31,9 @@ public function __construct($role)`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`/**`
`34`		`- * {@inheritdoc}`
	`34`	`+ * Returns a string representation of the role.`
	`35`	`+ *`
	`36`	`+ * @return string`
`35`	`37`	`*/`
`36`	`38`	`public function getRole()`
`37`	`39`	`{`