Add user mentions feature

appinfo/routes.php

@@ -36,6 +36,7 @@
 		['name' => 'Session#sync', 'url' => '/session/sync', 'verb' => 'POST'],
 		['name' => 'Session#push', 'url' => '/session/push', 'verb' => 'POST'],
 		['name' => 'Session#close', 'url' => '/session/close', 'verb' => 'POST'],
+		['name' => 'Session#mention', 'url' => '/session/mention', 'verb' => 'PUT'],
 
 		['name' => 'PublicSession#create', 'url' => '/public/session/create', 'verb' => 'PUT'],
 		['name' => 'PublicSession#updateSession', 'url' => '/public/session', 'verb' => 'POST'],
@@ -46,6 +47,8 @@
 		['name' => 'PublicSession#close', 'url' => '/public/session/close', 'verb' => 'POST'],
 
 		['name' => 'Settings#updateConfig', 'url' => '/settings', 'verb' => 'POST'],
+
+		['name' => 'UserApi#index', 'url' => '/api/v1/users', 'verb' => 'POST'],
 	],
 	'ocs' => [
 		['name' => 'Workspace#folder', 'url' => '/workspace', 'verb' => 'GET'],

css/style.scss

@@ -1,3 +1,5 @@
+@use 'sass:math';
+
 :root {
 	--text-editor-max-width: 670px
 }
@@ -99,3 +101,4 @@ li.ProseMirror-selectednode:after {
 .fadeInLeft {
   animation-name: fadeInLeft;
 }
+

js/vendors.js.LICENSE.txt

@@ -50,6 +50,8 @@
 
 /*! For license information please see NcModal.js.LICENSE.txt */
 
+/*! For license information please see NcUserBubble.js.LICENSE.txt */
+
 /*! For license information please see Tooltip.js.LICENSE.txt */
 
 /*! For license information please see emoji.js.LICENSE.txt */

lib/AppInfo/Application.php

@@ -34,6 +34,7 @@
 use OCA\Text\Listeners\FilesSharingLoadAdditionalScriptsListener;
 use OCA\Text\Listeners\LoadViewerListener;
 use OCA\Text\Listeners\RegisterDirectEditorEventListener;
+use OCA\Text\Notification\Notifier;
 use OCA\Text\Service\ConfigService;
 use OCA\Viewer\Event\LoadViewer;
 use OCP\AppFramework\App;
@@ -64,6 +65,7 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(NodeCopiedEvent::class, NodeCopiedListener::class);
 		$context->registerEventListener(BeforeNodeRenamedEvent::class, BeforeNodeRenamedListener::class);
 		$context->registerEventListener(BeforeNodeDeletedEvent::class, BeforeNodeDeletedListener::class);
+		$context->registerNotifierService(Notifier::class);
 	}
 
 	public function boot(IBootContext $context): void {

lib/Controller/SessionController.php

@@ -26,17 +26,23 @@
 namespace OCA\Text\Controller;
 
 use OCA\Text\Service\ApiService;
+use OCA\Text\Service\NotificationService;
+use OCA\Text\Service\SessionService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\Response;
 use OCP\IRequest;
 
 class SessionController extends Controller {
 	private ApiService $apiService;
+	private SessionService $sessionService;
+	private NotificationService $notificationService;
 
-	public function __construct(string $appName, IRequest $request, ApiService $apiService) {
+	public function __construct(string $appName, IRequest $request, ApiService $apiService, SessionService $sessionService, NotificationService $notificationService) {
 		parent::__construct($appName, $request);
 		$this->apiService = $apiService;
+		$this->sessionService = $sessionService;
+		$this->notificationService = $notificationService;
 	}
 
 	/**
@@ -77,4 +83,23 @@ public function push(int $documentId, int $sessionId, string $sessionToken, int
 	public function sync(int $documentId, int $sessionId, string $sessionToken, int $version = 0, string $autosaveContent = null, bool $force = false, bool $manualSave = false): DataResponse {
 		return $this->apiService->sync($documentId, $sessionId, $sessionToken, $version, $autosaveContent, $force, $manualSave);
 	}
+
+	/**
+	 * @NoAdminRequired
+	 * @PublicPage
+	 * @UserRateThrottle(limit=5, period=120)
+	 */
+	public function mention(int $documentId, int $sessionId, string $sessionToken, string $mention): DataResponse {
+		if (!$this->sessionService->isValidSession($documentId, $sessionId, $sessionToken)) {
+			return new DataResponse([], 403);
+		}
+
+		$currentSession = $this->sessionService->getSession($documentId, $sessionId, $sessionToken);
+
+		if ($currentSession->getUserId() === null && !$this->sessionService->isUserInDocument($documentId, $mention)) {
+			return new DataResponse([], 403);
+		}
+
+		return new DataResponse($this->notificationService->mention($documentId, $mention));
+	}
 }

lib/Controller/UserApiController.php

@@ -0,0 +1,69 @@
+<?php
+
+namespace OCA\Text\Controller;
+
+use OCA\Text\Service\SessionService;
+use \OCP\AppFramework\ApiController;
+use OCP\AppFramework\Http\DataResponse;
+use OCP\Collaboration\Collaborators\ISearch;
+use \OCP\IRequest;
+use OCP\IUserManager;
+use OCP\IUserSession;
+use OCP\Share\IShare;
+
+class UserApiController extends ApiController {
+	private ISearch $collaboratorSearch;
+	private IUserSession $userSession;
+	private IUserManager $userManager;
+	private SessionService $sessionService;
+
+	public function __construct($appName, IRequest $request, SessionService $sessionService, ISearch $ISearch, IUserManager $userManager, IUserSession $userSession) {
+		parent::__construct($appName, $request);
+
+		$this->sessionService = $sessionService;
+		$this->collaboratorSearch = $ISearch;
+		$this->userSession = $userSession;
+		$this->userManager = $userManager;
+		$this->sessionService = $sessionService;
+	}
+
+	/**
+	 * @NoAdminRequired
+	 * @PublicPage
+	 */
+	public function index(int $documentId, int $sessionId, string $sessionToken, string $filter, int $limit = 5): DataResponse {
+		if (!$this->sessionService->isValidSession($documentId, $sessionId, $sessionToken)) {
+			return new DataResponse([], 403);
+		}
+
+		$sessions = $this->sessionService->getAllSessions($documentId);
+
+		$users = [];
+
+		// Add joined users to the autocomplete list
+		foreach ($sessions as $session) {
+			$sessionUserId = $session['userId'];
+			if ($sessionUserId !== null && !isset($users[$sessionUserId])) {
+				$users[$sessionUserId] = $this->userManager->getDisplayName($sessionUserId);
+			}
+		}
+
+		$currentSession = $this->sessionService->getSession($documentId, $sessionId, $sessionToken);
+		if ($currentSession->getUserId() !== null) {
+			// Add other users to the autocomplete list
+			[$result] = $this->collaboratorSearch->search($filter, [IShare::TYPE_USER], false, $limit, 0);
+
+			foreach ($result['users'] as ['label' => $label, 'value' => $value]) {
+				if (isset($value['shareWith'])) {
+					$id = $value['shareWith'];
+					$users[$id] = $label;
+				}
+			}
+
+			$user = $this->userSession->getUser();
+			$users[$user->getUID()] = $user->getDisplayName();
+		}
+
+		return new DataResponse($users);
+	}
+}

lib/Db/SessionMapper.php

@@ -117,4 +117,22 @@ public function deleteByDocumentId($documentId) {
 			->where($qb->expr()->eq('document_id', $qb->createNamedParameter($documentId)));
 		return $qb->execute();
 	}
+
+	public function isUserInDocument($documentId, $userId): bool {
+		$qb = $this->db->getQueryBuilder();
+		$result = $qb->select('*')
+			->from($this->getTableName())
+			->where($qb->expr()->eq('document_id', $qb->createNamedParameter($documentId)))
+			->andWhere($qb->expr()->eq('user_id', $qb->createNamedParameter($userId)))
+			->setMaxResults(1)
+			->executeQuery();
+
+		$data = $result->fetch();
+		$result->closeCursor();
+		if ($data === false) {
+			return false;
+		}
+
+		return true;
+	}
 }