wip: test dav collection

appinfo/info.xml

@@ -9,7 +9,7 @@
 	<name>Recommendations</name>
 	<summary>Shows recommended files</summary>
 	<description>Shows recommended files for quick access of files and folders with recent activity</description>
-	<version>5.0.0-dev.0</version>
+	<version>5.0.0-dev.1</version>
 	<licence>agpl</licence>
 	<author>Christoph Wurst</author>
 	<author>Jan-Christoph Borchardt</author>
@@ -19,7 +19,19 @@
 	<dependencies>
 		<nextcloud min-version="32" max-version="32" />
 	</dependencies>
+	<types>
+		<filesystem/>
+		<dav/>
+	</types>
 	<commands>
 		<command>OCA\Recommendations\Command\GetRecommendations</command>
 	</commands>
+	<sabre>
+		<collections>
+			<collection>OCA\Recommendations\Sabre\RootCollection</collection>
+		</collections>
+		<plugins>
+			<plugin>OCA\Recommendations\Sabre\PropFindPlugin</plugin>
+		</plugins>
+	</sabre>
 </info>

lib/AppInfo/Application.php

@@ -9,6 +9,7 @@
 
 namespace OCA\Recommendations\AppInfo;
 
+use OCA\DAV\Connector\Sabre\Principal;
 use OCA\Files\Event\LoadAdditionalScriptsEvent;
 use OCA\Recommendations\Capabilities;
 use OCA\Recommendations\Dashboard\RecommendationWidget;
@@ -29,6 +30,7 @@
 		$context->registerEventListener(LoadAdditionalScriptsEvent::class, FilesLoadAdditionalScriptsListener::class);
 		$context->registerDashboardWidget(RecommendationWidget::class);
 		$context->registerCapability(Capabilities::class);
+		$context->registerServiceAlias('principalBackend', Principal::class);
 	}
 
 	public function boot(IBootContext $context): void {

lib/Command/GetRecommendations.php

@@ -49,12 +49,12 @@ public function execute(InputInterface $input, OutputInterface $output) {
 		);
 
 		if (is_null($user)) {
-			$output->writeln("user does not exist");
+			$output->writeln('user does not exist');
 			return 1;
 		}
 
 		if ($input->getArgument('max')) {
-			$recommendations = $this->recommendationService->getRecommendations($user, (int) $input->getArgument('max'));
+			$recommendations = $this->recommendationService->getRecommendations($user, (int)$input->getArgument('max'));
 		} else {
 			$recommendations = $this->recommendationService->getRecommendations($user);
 		}

lib/Controller/RecommendationController.php

@@ -50,7 +50,7 @@ public function __construct(IRequest $request,
 	public function index(): DataResponse {
 		$user = $this->userSession->getUser();
 		if (is_null($user)) {
-			throw new Exception("Not logged in");
+			throw new Exception('Not logged in');
 		}
 		$response = [];
 		$response['enabled'] = $this->config->getUserValue($user->getUID(), Application::APP_ID, 'enabled', 'true') === 'true';
@@ -73,7 +73,7 @@ public function index(): DataResponse {
 	public function always(): DataResponse {
 		$user = $this->userSession->getUser();
 		if (is_null($user)) {
-			throw new Exception("Not logged in");
+			throw new Exception('Not logged in');
 		}
 		$response = [
 			'enabled' => $this->config->getUserValue($user->getUID(), Application::APP_ID, 'enabled', 'true') === 'true',

lib/Controller/SettingsController.php

@@ -40,7 +40,7 @@ public function __construct($appName,
 	public function getSettings(): JSONResponse {
 		$user = $this->userSession->getUser();
 		if (!$user instanceof IUser) {
-			throw new Exception("Not logged in");
+			throw new Exception('Not logged in');
 		}
 		return new JSONResponse([
 			'enabled' => $this->config->getUserValue($user->getUID(), Application::APP_ID, 'enabled', 'true') === 'true',
@@ -55,7 +55,7 @@ public function getSettings(): JSONResponse {
 	public function setSetting(string $key, string $value): JSONResponse {
 		$user = $this->userSession->getUser();
 		if (!$user instanceof IUser) {
-			throw new Exception("Not logged in");
+			throw new Exception('Not logged in');
 		}
 		$availableSettings = ['enabled'];
 		if (!in_array($key, $availableSettings)) {

lib/Dashboard/RecommendationWidget.php

@@ -37,7 +37,7 @@ public function __construct(
 		IURLGenerator $urlGenerator,
 		IMimeTypeDetector $mimeTypeDetector,
 		RecommendationService $recommendationService,
-		IUserManager $userManager
+		IUserManager $userManager,
 	) {
 		$this->userSession = $userSession;
 		$this->l10n = $l10n;

lib/ResponseDefinitions.php

@@ -17,6 +17,7 @@
  *     mimeType: string,
  *     hasPreview: bool,
  *     reason: string,
+ *     reasonLabel: string,
  * }
  *
  * @psalm-suppress UnusedClass

lib/Sabre/IRecommendationNode.php

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Recommendations\Sabre;
+
+interface IRecommendationNode {
+	public function getRecommendationReason(): string;
+	public function getRecommendationReasonLabel(): string;
+}

lib/Sabre/PropFindPlugin.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Recommendations\Sabre;
+
+use OCP\Files\Folder;
+use Sabre\DAV\INode;
+use Sabre\DAV\PropFind;
+use Sabre\DAV\Server;
+use Sabre\DAV\ServerPlugin;
+
+class PropFindPlugin extends ServerPlugin {
+	private ?Folder $userFolder = null;
+
+	public const RECOMMENDATION_REASON = '{http://nextcloud.org/ns}recommendation-reason';
+	public const RECOMMENDATION_REASON_LABEL = '{http://nextcloud.org/ns}recommendation-reason-label';
+	public const RECOMMENDATION_ORIGINAL_LOCATION = '{http://nextcloud.org/ns}recommendation-original-location';
+
+	public function getPluginName(): string {
+		return 'recommendationsPropFindPlugin';
+	}
+
+	public function initialize(Server $server): void {
+		$server->on('propFind', $this->propFind(...));
+	}
+
+	public function propFind(PropFind $propFind, INode $node): void {
+		if ($node instanceof RecommendationDirectory || $node instanceof RecommendationFile) {
+			$propFind->handle(
+				self::RECOMMENDATION_REASON,
+				/** @psalm-suppress PossiblyNullReference Null already checked above */
+				fn () => $node->getRecommendationReason(),
+			);
+			$propFind->handle(
+				self::RECOMMENDATION_REASON_LABEL,
+				/** @psalm-suppress PossiblyNullReference Null already checked above */
+				fn () => $node->getRecommendationReasonLabel(),
+			);
+			$propFind->handle(
+				self::RECOMMENDATION_ORIGINAL_LOCATION,
+				/** @psalm-suppress PossiblyNullReference Null already checked above */
+				fn () => $node->getPath(),
+			);
+		}
+	}
+}

lib/Sabre/RecommendationDirectory.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Recommendations\Sabre;
+
+use OC\Files\View;
+use OCA\DAV\Connector\Sabre\CachingTree;
+use OCA\DAV\Connector\Sabre\Directory;
+use OCP\Files\FileInfo;
+use OCP\Share\IManager;
+
+class RecommendationDirectory extends Directory implements IRecommendationNode {
+	public function __construct(
+		private string $recommendationReason,
+		private string $recommendationReasonLabel,
+		View $view,
+		FileInfo $info,
+		?CachingTree $tree = null,
+		?IManager $shareManager = null,
+	) {
+		parent::__construct($view, $info, $tree, $shareManager);
+	}
+
+
+	public function getRecommendationReason(): string {
+		return $this->recommendationReason;
+	}
+
+	public function getRecommendationReasonLabel(): string {
+		return $this->recommendationReasonLabel;
+	}
+}

lib/Sabre/RecommendationFile.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCA\Recommendations\Sabre;
+
+use OC\Files\View;
+use OCA\DAV\Connector\Sabre\File;
+use OCP\Files\FileInfo;
+use OCP\IL10N;
+use OCP\IRequest;
+use OCP\Share\IManager;
+
+class RecommendationFile extends File implements IRecommendationNode {
+	public function __construct(
+		private string $recommendationReason,
+		private string $recommendationReasonLabel,
+		View $view,
+		FileInfo $info,
+		?IManager $shareManager = null,
+		?IRequest $request = null,
+		?IL10N $l10n = null,
+	) {
+		parent::__construct($view, $info, $shareManager, $request, $l10n);
+	}
+
+	public function getRecommendationReason(): string {
+		return $this->recommendationReason;
+	}
+
+	public function getRecommendationReasonLabel(): string {
+		return $this->recommendationReasonLabel;
+	}
+}

lib/Sabre/RecommendationsHome.php

@@ -0,0 +1,132 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+namespace OCA\Recommendations\Sabre;
+
+use OC\Files\Filesystem;
+use OC\Files\View;
+use OCA\Recommendations\AppInfo\Application;
+use OCA\Recommendations\Service\IRecommendation;
+use OCA\Recommendations\Service\RecommendationService;
+use OCP\Files\FileInfo;
+use OCP\IConfig;
+use OCP\IL10N;
+use OCP\IRequest;
+use OCP\IUser;
+use OCP\Share\IManager;
+use Sabre\DAV\Exception\Forbidden;
+use Sabre\DAV\Exception\NotFound;
+use Sabre\DAV\ICollection;
+
+class RecommendationsHome implements ICollection {
+
+	/** @var ?list<IRecommendation> */
+	private ?array $cachedRecommendations = null;
+
+	private View $fileView;
+
+	public function __construct(
+		private array $principalInfo,
+		private IUser $user,
+		private IConfig $config,
+		private RecommendationService $recommendationService,
+		private IManager $shareManager,
+		private IRequest $request,
+		private IL10N $l10n,
+	) {
+		$this->fileView = Filesystem::getView();
+	}
+
+	public function delete() {
+		throw new Forbidden();
+	}
+
+	public function getName(): string {
+		[, $name] = \Sabre\Uri\split($this->principalInfo['uri']);
+		return $name;
+	}
+
+	public function setName($name) {
+		throw new Forbidden();
+	}
+
+	public function createFile($name, $data = null) {
+		throw new Forbidden();
+	}
+
+	public function createDirectory($name) {
+		throw new Forbidden();
+	}
+
+	public function getChild($name) {
+		if (!$this->isEnabled()) {
+			throw new NotFound('Recommendations are disabled');
+		}
+
+		$recommendations = $this->getChildren();
+		foreach ($recommendations as $child) {
+			if ($child->getName() === $name) {
+				return $child;
+			}
+		}
+
+		throw new NotFound("Child '$name' not found in recommendations");
+	}
+
+	public function getChildren(): array {
+		if (!$this->isEnabled()) {
+			return [];
+		}
+
+		if ($this->cachedRecommendations === null) {
+			$this->cachedRecommendations = $this->recommendationService->getRecommendations($this->user);
+		}
+
+		return array_map(
+			function (IRecommendation $recommendation) {
+				$fileInfo = $recommendation->getNode()->getFileInfo();
+				if ($recommendation->getNode()->getType() === FileInfo::TYPE_FOLDER) {
+					return new RecommendationDirectory(
+						$recommendation->getReason(),
+						$recommendation->getReasonLabel(),
+						$this->fileView,
+						$fileInfo,
+						null,
+						$this->shareManager,
+					);
+				}
+				return new RecommendationFile(
+					$recommendation->getReason(),
+					$recommendation->getReasonLabel(),
+					$this->fileView,
+					$fileInfo,
+					$this->shareManager,
+					$this->request,
+					$this->l10n
+				);
+			},
+			$this->cachedRecommendations
+		);
+	}
+
+	public function childExists($name): bool {
+		if (!$this->isEnabled()) {
+			return false;
+		}
+		// TODO: map the recommendations to a Sabre node type
+		return true;
+	}
+
+	public function getLastModified(): int {
+		return 0;
+	}
+
+	private function isEnabled(): bool {
+		return $this->config->getUserValue($this->user->getUID(), Application::APP_ID, 'enabled', 'true') === 'true';
+	}
+}