removed usage of IUserStorage (BC break)

Author: dg

src/Bridges/SecurityDI/SecurityExtension.php

@@ -80,10 +80,6 @@ public function loadConfiguration()
 			$storage->addSetup('setCookieParameters', [$auth->cookieName, $auth->cookieDomain, $auth->cookieSamesite]);
 		}
 
-		$builder->addDefinition($this->prefix('legacyUserStorage')) // deprecated
-			->setType(Nette\Security\IUserStorage::class)
-			->setFactory(Nette\Http\UserStorage::class);
-
 		$user = $builder->addDefinition($this->prefix('user'))
 			->setFactory(Nette\Security\User::class);
 

src/Security/IUserStorage.php

@@ -21,38 +21,5 @@ interface IUserStorage
 		INACTIVITY = 0b0010;
 
 	/** Log-out behavior */
-	public const CLEAR_IDENTITY = 0b1000;
-
-	/**
-	 * Sets the authenticated status of this user.
-	 * @return static
-	 */
-	function setAuthenticated(bool $state);
-
-	/**
-	 * Is this user authenticated?
-	 */
-	function isAuthenticated(): bool;
-
-	/**
-	 * Sets the user identity.
-	 * @return static
-	 */
-	function setIdentity(?IIdentity $identity);
-
-	/**
-	 * Returns current user identity, if any.
-	 */
-	function getIdentity(): ?IIdentity;
-
-	/**
-	 * Enables log out from the persistent storage after inactivity (like '20 minutes'). Accepts flag IUserStorage::CLEAR_IDENTITY.
-	 * @return static
-	 */
-	function setExpiration(?string $expire, int $flags = 0);
-
-	/**
-	 * Why was user logged out?
-	 */
-	function getLogoutReason(): ?int;
+	public const CLEAR_IDENTITY = true;
 }

src/Security/User.php

@@ -55,7 +55,7 @@ class User
 	public iterable $onLoggedOut = [];
 
 	/** Session storage for current user */
-	private UserStorage|IUserStorage $storage;
+	private UserStorage $storage;
 	private ?IAuthenticator $authenticator;
 	private ?Authorizator $authorizator;
 	private ?IIdentity $identity = null;
@@ -64,22 +64,17 @@ class User
 
 
 	public function __construct(
-		?IUserStorage $legacyStorage = null,
+		UserStorage $storage,
 		?IAuthenticator $authenticator = null,
 		?Authorizator $authorizator = null,
-		?UserStorage $storage = null,
 	) {
-		$this->storage = $storage ?? $legacyStorage; // back compatibility
-		if (!$this->storage) {
-			throw new Nette\InvalidStateException('UserStorage has not been set.');
-		}
-
+		$this->storage = $storage;
 		$this->authenticator = $authenticator;
 		$this->authorizator = $authorizator;
 	}
 
 
-	final public function getStorage(): UserStorage|IUserStorage
+	final public function getStorage(): UserStorage
 	{
 		return $this->storage;
 	}
@@ -108,13 +103,8 @@ public function login(string|IIdentity $user, ?string $password = null): void
 		$id = $this->authenticator instanceof IdentityHandler
 			? $this->authenticator->sleepIdentity($this->identity)
 			: $this->identity;
-		if ($this->storage instanceof UserStorage) {
-			$this->storage->saveAuthentication($id);
-		} else {
-			$this->storage->setIdentity($id);
-			$this->storage->setAuthenticated(true);
-		}
 
+		$this->storage->saveAuthentication($id);
 		$this->authenticated = true;
 		$this->logoutReason = null;
 		Arrays::invoke($this->onLoggedIn, $this);
@@ -127,16 +117,7 @@ public function login(string|IIdentity $user, ?string $password = null): void
 	final public function logout(bool $clearIdentity = false): void
 	{
 		$logged = $this->isLoggedIn();
-
-		if ($this->storage instanceof UserStorage) {
-			$this->storage->clearAuthentication($clearIdentity);
-		} else {
-			$this->storage->setAuthenticated(false);
-			if ($clearIdentity) {
-				$this->storage->setIdentity(null);
-			}
-		}
-
+		$this->storage->clearAuthentication($clearIdentity);
 		$this->authenticated = false;
 		$this->logoutReason = self::MANUAL;
 		if ($logged) {
@@ -175,17 +156,11 @@ final public function getIdentity(): ?IIdentity
 
 	private function getStoredData(): void
 	{
-		if ($this->storage instanceof UserStorage) {
-			(function (bool $state, ?IIdentity $id, ?int $reason) use (&$identity) {
-				$identity = $id;
-				$this->authenticated = $state;
-				$this->logoutReason = $reason;
-			})(...$this->storage->getState());
-		} else {
-			$identity = $this->storage->getIdentity();
-			$this->authenticated = $this->storage->isAuthenticated();
-			$this->logoutReason = $this->storage->getLogoutReason();
-		}
+		(function (bool $state, ?IIdentity $id, ?int $reason) use (&$identity) {
+			$identity = $id;
+			$this->authenticated = $state;
+			$this->logoutReason = $reason;
+		})(...$this->storage->getState());
 
 		$this->identity = $identity && $this->authenticator instanceof IdentityHandler
 			? $this->authenticator->wakeupIdentity($identity)
@@ -252,12 +227,9 @@ final public function hasAuthenticator(): bool
 	/**
 	 * Enables log out after inactivity (like '20 minutes').
 	 */
-	public function setExpiration(?string $expire, bool|int|null $clearIdentity = null)
+	public function setExpiration(?string $expire, bool $clearIdentity = false)
 	{
-		$arg = $this->storage instanceof UserStorage
-			? (bool) $clearIdentity
-			: ($clearIdentity ? IUserStorage::CLEAR_IDENTITY : 0);
-		$this->storage->setExpiration($expire, $arg);
+		$this->storage->setExpiration($expire, $clearIdentity);
 		return $this;
 	}
 

tests/Security.DI/SecurityExtension.user.phpt

@@ -25,7 +25,6 @@ eval($compiler->compile());
 $container = new Container;
 
 Assert::type(Nette\Bridges\SecurityHttp\SessionStorage::class, $container->getService('security.userStorage'));
-Assert::type(Nette\Http\UserStorage::class, $container->getService('security.legacyUserStorage'));
 Assert::type(Nette\Security\User::class, $container->getService('security.user'));
 
 // aliases

tests/Security/MockUserStorage.legacy.php

@@ -36,7 +36,7 @@ class Authenticator implements Nette\Security\Authenticator
 }
 
 
-$user = new Nette\Security\User(null, null, null, new MockUserStorage);
+$user = new Nette\Security\User(new MockUserStorage);
 
 $counter = (object) [
 	'login' => 0,

tests/Security/User.authentication.legacy.phpt

@@ -54,7 +54,7 @@ class TesterRole implements Role
 	}
 }
 
-$user = new Nette\Security\User(null, null, null, new MockUserStorage);
+$user = new Nette\Security\User(new MockUserStorage);
 
 // guest
 Assert::false($user->isLoggedIn());