feat(dav): allow extending propfind properties via event

Signed-off-by: Benjamin Frueh <[email protected]>

Author: benjaminfrueh

lib/private/Files/Storage/DAV.php

@@ -15,6 +15,8 @@
 use OCP\AppFramework\Http;
 use OCP\Constants;
 use OCP\Diagnostics\IEventLogger;
+use OCP\EventDispatcher\IEventDispatcher;
+use OCP\Files\Events\BeforePropfindEvent;
 use OCP\Files\FileInfo;
 use OCP\Files\ForbiddenException;
 use OCP\Files\IMimeTypeDetector;
@@ -232,6 +234,34 @@ public function opendir(string $path) {
 		return false;
 	}
 
+	/**
+	 * @return array<string>
+	 */
+	protected function getPropfindProperties(): array {
+		$event = new BeforePropfindEvent(self::PROPFIND_PROPS);
+		Server::get(IEventDispatcher::class)->dispatchTyped($event);
+		return $event->getProperties();
+	}
+
+	/**
+	 *  Get property value from cached PROPFIND response.
+	 *  For accessing app-specific properties not included in getMetaData().
+	 *
+	 * @param string $path
+	 * @param string $propertyName
+	 * @return mixed
+	 */
+	public function getPropfindPropertyValue(string $path, string $propertyName): mixed {
+		$path = $this->cleanPath($path);
+		$propfindResponse = $this->statCache->get($path);
+
+		if (!is_array($propfindResponse)) {
+			return null;
+		}
+
+		return $propfindResponse[$propertyName] ?? null;
+	}
+
 	/**
 	 * Propfind call with cache handling.
 	 *
@@ -254,7 +284,7 @@ protected function propfind(string $path): array|false {
 			try {
 				$response = $this->client->propFind(
 					$this->encodePath($path),
-					self::PROPFIND_PROPS
+					$this->getPropfindProperties()
 				);
 				$this->statCache->set($path, $response);
 			} catch (ClientHttpException $e) {
@@ -818,7 +848,7 @@ public function getDirectoryContent(string $directory): \Traversable {
 		try {
 			$responses = $this->client->propFind(
 				$this->encodePath($directory),
-				self::PROPFIND_PROPS,
+				$this->getPropfindProperties(),
 				1
 			);
 

lib/public/Files/Events/BeforePropfindEvent.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OCP\Files\Events;
+
+use OCP\EventDispatcher\Event;
+
+/**
+ * @since 32.0.0
+ */
+class BeforePropfindEvent extends Event {
+	private array $properties;
+
+	public function __construct(array $properties) {
+		parent::__construct();
+		$this->properties = $properties;
+	}
+
+	/**
+	 * @return array<string>
+	 * @since 32.0.0
+	 */
+	public function getProperties(): array {
+		return $this->properties;
+	}
+
+	/**
+	 * @param array<string> $properties
+	 * @since 32.0.0
+	 */
+	public function addProperties(array $properties): void {
+		$this->properties = [...$this->properties, ...$properties];
+	}
+}