feat(Capabilities): Expose capabilities

Signed-off-by: Marcel Klehr <mklehr@gmx.net>

Author: marcelklehr

lib/AppInfo/Application.php

@@ -9,6 +9,7 @@
 namespace OCA\Bookmarks\AppInfo;
 
 use OCA\Bookmarks\Activity\ActivityPublisher;
+use OCA\Bookmarks\Capabilities;
 use OCA\Bookmarks\ContextChat\ContextChatProvider;
 use OCA\Bookmarks\Dashboard\Frequent;
 use OCA\Bookmarks\Dashboard\Recent;
@@ -72,6 +73,8 @@ public function register(IRegistrationContext $context): void {
 			return $c->get(IRequest::class);
 		});
 
+		$context->registerCapability(Capabilities::class);
+
 		$context->registerSearchProvider(Provider::class);
 		$context->registerDashboardWidget(Recent::class);
 		$context->registerDashboardWidget(Frequent::class);

lib/Capabilities.php

@@ -0,0 +1,22 @@
+<?php
+
+/*
+ * Copyright (c) 2025. The Nextcloud Bookmarks contributors.
+ *
+ * This file is licensed under the Affero General Public License version 3 or later. See the COPYING file.
+ */
+
+namespace OCA\Bookmarks;
+
+use OCP\Capabilities\IPublicCapability;
+
+class Capabilities implements IPublicCapability {
+	public function getCapabilities() {
+		return [
+			'bookmarks' => [
+				'javascript-bookmarks' => true,
+				'hash-functions' => ['xxh32', 'murmur3a', 'sha256'], // ordered by preference
+			]
+		];
+	}
+}

lib/Controller/FoldersController.php

@@ -427,15 +427,18 @@ public function editFolder(int $folderId, ?string $title = null, ?int $parent_fo
 	 * @PublicPage
 	 * @throws UnauthenticatedError
 	 */
-	public function hashFolder(int $folderId, array $fields = ['title', 'url']): JSONResponse {
+	public function hashFolder(int $folderId, array $fields = ['title', 'url'], string $hashFn = 'sha256'): JSONResponse {
 		if (!Authorizer::hasPermission(Authorizer::PERM_READ, $this->authorizer->getPermissionsForFolder($folderId, $this->request))) {
 			$res = new JSONResponse(['status' => 'error', 'data' => ['Could not find folder']], Http::STATUS_BAD_REQUEST);
 			$res->throttle();
 			return $res;
 		}
+		if (!in_array($hashFn, ['sha256', 'murmur3a', 'xxh32'], true)) {
+			return new JSONResponse(['status' => 'error', 'data' => ['Unsupported hash function']], Http::STATUS_BAD_REQUEST);
+		}
 		try {
 			$folderId = $this->toInternalFolderId($folderId);
-			$hash = $this->hashManager->hashFolder($this->authorizer->getUserId(), $folderId, $fields);
+			$hash = $this->hashManager->hashFolder($this->authorizer->getUserId(), $folderId, $fields, $hashFn);
 			$res = new JSONResponse(['status' => 'success', 'data' => $hash]);
 			$res->addHeader('Cache-Control', 'no-cache, must-revalidate');
 			$res->addHeader('Expires', 'Sat, 26 Jul 1997 05:00:00 GMT');

lib/Service/TreeCacheManager.php

@@ -181,9 +181,9 @@ public function invalidateBookmark(int $bookmarkId): void {
 	 * @throws MultipleObjectsReturnedException|\JsonException
 	 * @throws UnsupportedOperation
 	 */
-	public function hashFolder($userId, int $folderId, array $fields = ['title', 'url']) : string {
+	public function hashFolder($userId, int $folderId, array $fields = ['title', 'url'], string $hasFn = 'sha256') : string {
 		$hash = $this->get(self::CATEGORY_HASH, TreeMapper::TYPE_FOLDER, $folderId);
-		$selector = $userId . ':' . implode(',', $fields);
+		$selector = $hasFn . ':' . $userId . ':' . implode(',', $fields);
 		if (isset($hash[$selector])) {
 			return $hash[$selector];
 		}
@@ -198,9 +198,9 @@ public function hashFolder($userId, int $folderId, array $fields = ['title', 'ur
 		$childHashes = array_map(function ($item) use ($fields, $entity) {
 			switch ($item['type']) {
 				case TreeMapper::TYPE_BOOKMARK:
-					return $this->hashBookmark($item['id'], $fields);
+					return $this->hashBookmark($item['id'], $fields, $hashFn);
 				case TreeMapper::TYPE_FOLDER:
-					return $this->hashFolder($entity->getUserId(), $item['id'], $fields);
+					return $this->hashFolder($entity->getUserId(), $item['id'], $fields, $hashFn);
 				default:
 					throw new UnexpectedValueException('Expected bookmark or folder, but not ' . $item['type']);
 			}
@@ -212,7 +212,7 @@ public function hashFolder($userId, int $folderId, array $fields = ['title', 'ur
 			$folder['title'] = $entity->getTitle();
 		}
 		$folder['children'] = $childHashes;
-		$hash[$selector] = hash('sha256', json_encode($folder, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
+		$hash[$selector] = hash($hashFn, json_encode($folder, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
 
 		$this->set(self::CATEGORY_HASH, TreeMapper::TYPE_FOLDER, $folderId, $hash);
 		return $hash[$selector];
@@ -226,9 +226,9 @@ public function hashFolder($userId, int $folderId, array $fields = ['title', 'ur
 	 * @throws MultipleObjectsReturnedException|\JsonException
 	 * @throws UnsupportedOperation
 	 */
-	public function hashBookmark(int $bookmarkId, array $fields = ['title', 'url']): string {
+	public function hashBookmark(int $bookmarkId, array $fields = ['title', 'url'], string $hashFn = 'sha256'): string {
 		$hash = $this->get(self::CATEGORY_HASH, TreeMapper::TYPE_BOOKMARK, $bookmarkId);
-		$selector = implode(',', $fields);
+		$selector = $hashFn . ':' . implode(',', $fields);
 		if (isset($hash[$selector])) {
 			return $hash[$selector];
 		}
@@ -249,7 +249,7 @@ public function hashBookmark(int $bookmarkId, array $fields = ['title', 'url']):
 				throw new UnsupportedOperation('Field ' . $field . ' does not exist');
 			}
 		}
-		$hash[$selector] = hash('sha256', json_encode($bookmark, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
+		$hash[$selector] = hash($hashFn, json_encode($bookmark, JSON_THROW_ON_ERROR | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES));
 		$this->set(self::CATEGORY_HASH, TreeMapper::TYPE_BOOKMARK, $bookmarkId, $hash);
 		return $hash[$selector];
 	}