feat: Use X-NC-Nickname as user identifier

Signed-off-by: Louis Chemineau <louis@chmn.me>

Author: artonge

lib/CurrentUser.php

@@ -10,28 +10,22 @@
 use OCP\IRequest;
 use OCP\IUser;
 use OCP\IUserSession;
+use OCP\L10N\IFactory;
 use OCP\Share\Exceptions\ShareNotFound;
 use OCP\Share\IManager;
 use OCP\Share\IShare;
 
 class CurrentUser {
 
-	/** @var string */
-	protected $identifier;
-	/** @var string|null */
-	protected $cloudId;
-	/** @var string|false|null */
-	protected $sessionUser;
+	protected string|null $identifier;
+	protected string|null $cloudId;
+	protected string|false|null $sessionUser;
 
-	/**
-	 * @param IUserSession $userSession
-	 * @param IRequest $request
-	 * @param IManager $shareManager
-	 */
 	public function __construct(
 		protected IUserSession $userSession,
 		protected IRequest $request,
 		protected IManager $shareManager,
+		protected IFactory $l10nFactory,
 	) {
 		$this->cloudId = false;
 		$this->sessionUser = false;
@@ -46,19 +40,30 @@ public function getUser(): ?IUser {
 	 * @return string
 	 */
 	public function getUserIdentifier() {
-		if ($this->identifier === null) {
-			$this->identifier = $this->getUID();
+		if ($this->identifier !== null) {
+			return $this->identifier;
+		}
+
+		$uid = $this->getUID();
+		if ($uid !== null) {
+			$this->identifier = $uid;
+			return $this->identifier;
+		}
 
-			if ($this->identifier === null) {
-				$this->identifier = $this->getCloudIDFromToken();
+		$cloudId = $this->getCloudIDFromToken();
+		if ($cloudId !== null) {
+			$this->identifier = $cloudId;
+			return $this->identifier;
+		}
 
-				if ($this->identifier === null) {
-					// Nothing worked, fallback to empty string
-					$this->identifier = '';
-				}
-			}
+		$nickname = $this->request->getHeader('X-NC-Nickname');
+		if ($nickname !== '') {
+			$this->identifier = $nickname . ' (' . $this->l10nFactory->get('comments')->t('remote user') . ')';
+			return $this->identifier;
 		}
 
+		// Nothing worked, fallback to empty string
+		$this->identifier = '';
 		return $this->identifier;
 	}
 

tests/CurrentUserTest.php

@@ -26,6 +26,7 @@
 use OCP\IRequest;
 use OCP\IUser;
 use OCP\IUserSession;
+use OCP\L10N\IFactory;
 use OCP\Share\Exceptions\ShareNotFound;
 use OCP\Share\IManager;
 use OCP\Share\IShare;
@@ -42,33 +43,27 @@ abstract class RequestMock implements IRequest {
  * @package OCA\Activity\Tests
  */
 class CurrentUserTest extends TestCase {
-	/** @var IRequest|MockObject */
-	protected $request;
-
-	/** @var IUserSession|MockObject */
-	protected $userSession;
-
-	/** @var IManager|MockObject */
-	protected $shareManager;
+	protected IRequest&MockObject $request;
+	protected IUserSession&MockObject $userSession;
+	protected IManager&MockObject $shareManager;
+	protected IFactory&MockObject $l10nFactory;
 
 	protected function setUp(): void {
 		parent::setUp();
 
 		$this->request = $this->createMock(RequestMock::class);
 		$this->userSession = $this->createMock(IUserSession::class);
 		$this->shareManager = $this->createMock(IManager::class);
+		$this->l10nFactory = $this->createMock(IFactory::class);
 	}
 
-	/**
-	 * @param array $methods
-	 * @return CurrentUser|MockObject
-	 */
-	protected function getInstance(array $methods = []): CurrentUser {
+	protected function getInstance(array $methods = []): CurrentUser&MockObject {
 		if (empty($methods)) {
 			return new CurrentUser(
 				$this->userSession,
 				$this->request,
-				$this->shareManager
+				$this->shareManager,
+				$this->l10nFactory,
 			);
 		}
 
@@ -77,6 +72,7 @@ protected function getInstance(array $methods = []): CurrentUser {
 				$this->userSession,
 				$this->request,
 				$this->shareManager,
+				$this->l10nFactory,
 			])
 			->onlyMethods($methods)
 			->getMock();
@@ -118,11 +114,7 @@ public function testGetUserIdentifier(?string $cachedIdentifier, $uidResult, $to
 		$this->assertSame($expected, $instance->getUserIdentifier());
 	}
 
-	/**
-	 * @param string $uid
-	 * @return IUser
-	 */
-	protected function getUserMock(string $uid): IUser {
+	protected function getUserMock(string $uid): IUser&MockObject {
 		$user = $this->createMock(IUser::class);
 		$user->expects($this->once())
 			->method('getUID')
@@ -154,12 +146,7 @@ public function testGetUID(?IUser $user, ?string $expected): void {
 		$this->assertSame($expected, $instance->getUID());
 	}
 
-	/**
-	 * @param int $type
-	 * @param string $shareWith
-	 * @return IShare
-	 */
-	protected function getShareMock(int $type, ?string $shareWith): IShare {
+	protected function getShareMock(int $type, ?string $shareWith): IShare&MockObject {
 		$share = $this->createMock(IShare::class);
 		$share->expects($this->once())
 			->method('getShareType')