feat: Use X-NC-Nickname as user identifier

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

Author: artonge

lib/CurrentUser.php

@@ -10,31 +10,26 @@
 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;
+	protected $identifier = null;
 	/** @var string|false|null */
-	protected $sessionUser;
+	protected $cloudId = false;
+	/** @var string|false|null */
+	protected $sessionUser = false;
 
-	/**
-	 * @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;
 	}
 
 	public function getUser(): ?IUser {
@@ -46,19 +41,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;
+		}
 
-			if ($this->identifier === null) {
-				$this->identifier = $this->getCloudIDFromToken();
+		$uid = $this->getUID();
+		if ($uid !== null) {
+			$this->identifier = $uid;
+			return $this->identifier;
+		}
 
-				if ($this->identifier === null) {
-					// Nothing worked, fallback to empty string
-					$this->identifier = '';
-				}
-			}
+		$cloudId = $this->getCloudIDFromToken();
+		if ($cloudId !== null) {
+			$this->identifier = $cloudId;
+			return $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,14 +43,10 @@ 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();
@@ -68,7 +65,8 @@ protected function getInstance(array $methods = []): CurrentUser {
 			return new CurrentUser(
 				$this->userSession,
 				$this->request,
-				$this->shareManager
+				$this->shareManager,
+				$this->l10nFactory,
 			);
 		}
 
@@ -77,6 +75,7 @@ protected function getInstance(array $methods = []): CurrentUser {
 				$this->userSession,
 				$this->request,
 				$this->shareManager,
+				$this->l10nFactory,
 			])
 			->onlyMethods($methods)
 			->getMock();