refactor(trash): Introduce ICacheableDirectory interface

That interface can be implemented by any ICollection that is based on
one or multiple \OCP\Files\Folder to pre-fetch the custom properties.

Signed-off-by: Carl Schwan <carl.schwan@nextclound.com>

Author: Carl Schwan

apps/dav/lib/Connector/Sabre/Directory.php

@@ -13,6 +13,7 @@
 use OCA\DAV\Connector\Sabre\Exception\FileLocked;
 use OCA\DAV\Connector\Sabre\Exception\Forbidden;
 use OCA\DAV\Connector\Sabre\Exception\InvalidPath;
+use OCA\DAV\DAV\ICacheableDirectory;
 use OCA\DAV\Storage\PublicShareWrapper;
 use OCP\App\IAppManager;
 use OCP\Constants;
@@ -39,7 +40,7 @@
 use Sabre\DAV\IFile;
 use Sabre\DAV\INode;
 
-class Directory extends Node implements \Sabre\DAV\ICollection, \Sabre\DAV\IQuota, \Sabre\DAV\IMoveTarget, \Sabre\DAV\ICopyTarget {
+class Directory extends Node implements \Sabre\DAV\ICollection, \Sabre\DAV\IQuota, \Sabre\DAV\IMoveTarget, \Sabre\DAV\ICopyTarget, ICacheableDirectory {
 	/**
 	 * Cached directory content
 	 * @var FileInfo[]
@@ -490,4 +491,8 @@ public function copyInto($targetName, $sourcePath, INode $sourceNode) {
 	public function getNode(): Folder {
 		return $this->node;
 	}
+
+	public function getCacheableDirectories(): array {
+		return [$this->getNode()];
+	}
 }

apps/dav/lib/DAV/CustomPropertiesBackend.php

@@ -19,8 +19,6 @@
 use OCA\DAV\CalDAV\Trashbin\TrashbinHome;
 use OCA\DAV\Connector\Sabre\Directory;
 use OCA\DAV\Db\PropertyMapper;
-use OCA\DAV\Connector\Sabre\FilesPlugin;
-use OCA\Files_Trashbin\Sabre\TrashRoot;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\Files\Folder;
 use OCP\IDBConnection;
@@ -210,12 +208,10 @@ public function propFind($path, PropFind $propFind) {
 		}
 
 		$node = $this->tree->getNodeForPath($path);
-		if (($node instanceof Directory) && $propFind->getDepth() !== 0) {
-			$this->cacheDirectory($path, $node->getNode());
-		} else if ($node instanceof TrashRoot) {
-			$trashNodes = $node->getTrashRoots();
-			foreach ($trashNodes as $trashNode) {
-				$this->cacheDirectory($path, $trashNode);
+		if (($node instanceof ICacheableDirectory) && $propFind->getDepth() !== 0) {
+			$directoriesToPrefetch = $node->getCacheableDirectories();
+			foreach ($directoriesToPrefetch as $directory) {
+				$this->cacheDirectory($path, $directory);
 			}
 		}
 

apps/dav/lib/DAV/ICacheableDirectory.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace OCA\DAV\DAV;
+
+use OCP\Files\Folder;
+
+interface ICacheableDirectory {
+	/**
+	 * @return Folder[]
+	 */
+	public function getCacheableDirectories(): array;
+}

apps/files_trashbin/lib/Sabre/TrashRoot.php

@@ -8,22 +8,19 @@
  */
 namespace OCA\Files_Trashbin\Sabre;
 
+use OCA\DAV\DAV\ICacheableDirectory;
 use OCA\Files_Trashbin\Service\ConfigService;
 use OCA\Files_Trashbin\Trash\ITrashItem;
 use OCA\Files_Trashbin\Trash\ITrashManager;
 use OCA\Files_Trashbin\Trashbin;
 use OCP\Files\FileInfo;
 use OCP\Files\Folder;
-use OCP\Files\IRootFolder;
-use OCP\Files\NotFoundException;
-use OCP\Files\NotPermittedException;
 use OCP\IUser;
-use OCP\Server;
 use Sabre\DAV\Exception\Forbidden;
 use Sabre\DAV\Exception\NotFound;
 use Sabre\DAV\ICollection;
 
-class TrashRoot implements ICollection {
+class TrashRoot implements ICollection, ICacheableDirectory {
 	private ?Folder $trashFilesRoot = null;
 
 	public function __construct(
@@ -100,7 +97,7 @@ public function getLastModified(): int {
 	/**
 	 * @return Folder[]
 	 */
-	public function getTrashRoots(): array {
-		return $this->trashManager->getTrashRootsForUser($this->user);
+	public function getCacheableDirectories(): array {
+		return $this->trashManager->getCacheableRootsForUser($this->user);
 	}
 }

apps/files_trashbin/lib/Trash/ITrashBackend.php

@@ -67,8 +67,11 @@ public function moveToTrash(IStorage $storage, string $internalPath): bool;
 	public function getTrashNodeById(IUser $user, int $fileId);
 
 	/**
+	 * Returns a non-exhaustive list of folder which can then be used to pre-fetch some metadata
+	 * * for the trash root.
+	 *
 	 * @return Folder[]
 	 * @since 32.0.0
 	 */
-	public function getTrashRootsForUser(IUser $user): array;
+	public function getCacheableRootsForUser(IUser $user): array;
 }

apps/files_trashbin/lib/Trash/ITrashManager.php

@@ -38,9 +38,4 @@ public function pauseTrash();
 	 * @since 15.0.0
 	 */
 	public function resumeTrash();
-
-	/**
-	 * @since 32.0.0
-	 */
-	public function getTrashRootsForUser(IUser $user): array;
 }

apps/files_trashbin/lib/Trash/TrashManager.php

@@ -109,9 +109,8 @@ public function resumeTrash() {
 		$this->trashPaused = false;
 	}
 
-	public function getTrashRootsForUser(IUser $user): array {
-		return array_reduce($this->getBackends(), function (array $items, ITrashBackend $backend) use ($user) {
-			return array_merge($items, $backend->getTrashRootsForUser($user));
-		}, []);
+	public function getCacheableRootsForUser(IUser $user): array {
+		return array_reduce($this->getBackends(),
+			fn (array $items, ITrashBackend $backend) => array_merge($items, $backend->getCacheableRootsForUser($user)), []);
 	}
 }