feat(files_versions): Add listener and interfaces to allow versions m…

…igration across storages

Signed-off-by: Louis Chemineau <louis@chmn.me>

apps/files_versions/composer/composer/autoload_classmap.php

@@ -22,6 +22,7 @@
     'OCA\\Files_Versions\\Listener\\LoadAdditionalListener' => $baseDir . '/../lib/Listener/LoadAdditionalListener.php',
     'OCA\\Files_Versions\\Listener\\LoadSidebarListener' => $baseDir . '/../lib/Listener/LoadSidebarListener.php',
     'OCA\\Files_Versions\\Listener\\VersionAuthorListener' => $baseDir . '/../lib/Listener/VersionAuthorListener.php',
+    'OCA\\Files_Versions\\Listener\\VersionStorageMoveListener' => $baseDir . '/../lib/Listener/VersionStorageMoveListener.php',
     'OCA\\Files_Versions\\Migration\\Version1020Date20221114144058' => $baseDir . '/../lib/Migration/Version1020Date20221114144058.php',
     'OCA\\Files_Versions\\Sabre\\Plugin' => $baseDir . '/../lib/Sabre/Plugin.php',
     'OCA\\Files_Versions\\Sabre\\RestoreFolder' => $baseDir . '/../lib/Sabre/RestoreFolder.php',
@@ -41,6 +42,7 @@
     'OCA\\Files_Versions\\Versions\\IVersion' => $baseDir . '/../lib/Versions/IVersion.php',
     'OCA\\Files_Versions\\Versions\\IVersionBackend' => $baseDir . '/../lib/Versions/IVersionBackend.php',
     'OCA\\Files_Versions\\Versions\\IVersionManager' => $baseDir . '/../lib/Versions/IVersionManager.php',
+    'OCA\\Files_Versions\\Versions\\IVersionsImporterBackend' => $baseDir . '/../lib/Versions/IVersionsImporterBackend.php',
     'OCA\\Files_Versions\\Versions\\LegacyVersionsBackend' => $baseDir . '/../lib/Versions/LegacyVersionsBackend.php',
     'OCA\\Files_Versions\\Versions\\Version' => $baseDir . '/../lib/Versions/Version.php',
     'OCA\\Files_Versions\\Versions\\VersionManager' => $baseDir . '/../lib/Versions/VersionManager.php',

apps/files_versions/composer/composer/autoload_static.php

@@ -37,6 +37,7 @@ class ComposerStaticInitFiles_Versions
         'OCA\\Files_Versions\\Listener\\LoadAdditionalListener' => __DIR__ . '/..' . '/../lib/Listener/LoadAdditionalListener.php',
         'OCA\\Files_Versions\\Listener\\LoadSidebarListener' => __DIR__ . '/..' . '/../lib/Listener/LoadSidebarListener.php',
         'OCA\\Files_Versions\\Listener\\VersionAuthorListener' => __DIR__ . '/..' . '/../lib/Listener/VersionAuthorListener.php',
+        'OCA\\Files_Versions\\Listener\\VersionStorageMoveListener' => __DIR__ . '/..' . '/../lib/Listener/VersionStorageMoveListener.php',
         'OCA\\Files_Versions\\Migration\\Version1020Date20221114144058' => __DIR__ . '/..' . '/../lib/Migration/Version1020Date20221114144058.php',
         'OCA\\Files_Versions\\Sabre\\Plugin' => __DIR__ . '/..' . '/../lib/Sabre/Plugin.php',
         'OCA\\Files_Versions\\Sabre\\RestoreFolder' => __DIR__ . '/..' . '/../lib/Sabre/RestoreFolder.php',
@@ -56,6 +57,7 @@ class ComposerStaticInitFiles_Versions
         'OCA\\Files_Versions\\Versions\\IVersion' => __DIR__ . '/..' . '/../lib/Versions/IVersion.php',
         'OCA\\Files_Versions\\Versions\\IVersionBackend' => __DIR__ . '/..' . '/../lib/Versions/IVersionBackend.php',
         'OCA\\Files_Versions\\Versions\\IVersionManager' => __DIR__ . '/..' . '/../lib/Versions/IVersionManager.php',
+        'OCA\\Files_Versions\\Versions\\IVersionsImporterBackend' => __DIR__ . '/..' . '/../lib/Versions/IVersionsImporterBackend.php',
         'OCA\\Files_Versions\\Versions\\LegacyVersionsBackend' => __DIR__ . '/..' . '/../lib/Versions/LegacyVersionsBackend.php',
         'OCA\\Files_Versions\\Versions\\Version' => __DIR__ . '/..' . '/../lib/Versions/Version.php',
         'OCA\\Files_Versions\\Versions\\VersionManager' => __DIR__ . '/..' . '/../lib/Versions/VersionManager.php',

apps/files_versions/lib/AppInfo/Application.php

@@ -37,6 +37,7 @@
 use OCA\Files_Versions\Listener\LoadAdditionalListener;
 use OCA\Files_Versions\Listener\LoadSidebarListener;
 use OCA\Files_Versions\Listener\VersionAuthorListener;
+use OCA\Files_Versions\Listener\VersionStorageMoveListener;
 use OCA\Files_Versions\Versions\IVersionManager;
 use OCA\Files_Versions\Versions\VersionManager;
 use OCP\Accounts\IAccountManager;
@@ -109,6 +110,8 @@ public function register(IRegistrationContext $context): void {
 		$context->registerEventListener(LoadAdditionalScriptsEvent::class, LoadAdditionalListener::class);
 		$context->registerEventListener(LoadSidebar::class, LoadSidebarListener::class);
 
+		$context->registerEventListener(BeforeNodeRenamedEvent::class, VersionStorageMoveListener::class);
+
 		$context->registerEventListener(NodeCreatedEvent::class, FileEventsListener::class);
 		$context->registerEventListener(BeforeNodeTouchedEvent::class, FileEventsListener::class);
 		$context->registerEventListener(NodeTouchedEvent::class, FileEventsListener::class);

apps/files_versions/lib/Listener/FileEventsListener.php

@@ -300,6 +300,14 @@ public function pre_remove_hook(Node $node): void {
 	 * of the stored versions along the actual file
 	 */
 	public function rename_hook(Node $source, Node $target): void {
+		$sourceBackend = $this->versionManager->getBackendForStorage($source->getParent()->getStorage());
+		$targetBackend = $this->versionManager->getBackendForStorage($target->getStorage());
+
+		// If same storage, nothing to do
+		if ($sourceBackend !== $targetBackend) {
+			return;
+		}
+
 		$oldPath = $this->getPathForNode($source);
 		$newPath = $this->getPathForNode($target);
 		Storage::renameOrCopy($oldPath, $newPath, 'rename');
@@ -333,6 +341,15 @@ public function pre_renameOrCopy_hook(Node $source, Node $target): void {
 		$manager = Filesystem::getMountManager();
 		$mount = $manager->find($absOldPath);
 		$internalPath = $mount->getInternalPath($absOldPath);
+
+		$sourceBackend = $this->versionManager->getBackendForStorage($source->getStorage());
+		$targetBackend = $this->versionManager->getBackendForStorage($target->getParent()->getStorage());
+
+		// If same storage, nothing to do
+		if ($sourceBackend !== $targetBackend) {
+			return;
+		}
+
 		if ($internalPath === '' and $mount instanceof MoveableMount) {
 			return;
 		}

apps/files_versions/lib/Listener/VersionStorageMoveListener.php

@@ -0,0 +1,65 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2024 Louis Chmn <louis@chmn.me>
+ *
+ * @author Louis Chmn <louis@chmn.me>
+ *
+ * @license GNU AGPL-3.0-or-later
+ *
+ * This code is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License, version 3,
+ * as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License, version 3,
+ * along with this program. If not, see <http://www.gnu.org/licenses/>
+ *
+ */
+namespace OCA\Files_Versions\Listener;
+
+use Exception;
+use OCA\Files_Versions\Versions\IVersionManager;
+use OCP\EventDispatcher\Event;
+use OCP\EventDispatcher\IEventListener;
+use OCP\Files\Events\Node\BeforeNodeRenamedEvent;
+use OCP\Files\File;
+use OCP\IUserSession;
+
+/** @template-implements IEventListener<BeforeNodeRenamedEvent> */
+class VersionStorageMoveListener implements IEventListener {
+	public function __construct(
+		private IVersionManager $versionManager,
+		private IUserSession $userSession,
+	) {
+	}
+
+	/**
+	 * @abstract Moves version across storages if necessary.
+	 * @param Event $event
+	 */
+	public function handle(Event $event): void {
+		/** @var BeforeNodeRenamedEvent $event **/
+
+		$source = $event->getSource();
+		$target = $event->getTarget();
+
+		if (!($target instanceof File)) {
+			return;
+		}
+
+		$user = $this->userSession->getUser() ?? $source->getOwner();
+
+		if ($user === null) {
+			throw new Exception("Cannot move versions across storages without a user.");
+		}
+
+		$this->versionManager->moveVersionsAcrossBackends($user, $source, $target);
+	}
+}

apps/files_versions/lib/Versions/IMetadataVersion.php

@@ -28,6 +28,14 @@
  * @since 29.0.0
  */
 interface IMetadataVersion {
+	/**
+	 * retrieves the all the metadata
+	 *
+	 * @return string[]
+	 * @since 29.0.0
+	 */
+	public function getMetadata(): array;
+
 	/**
 	 * retrieves the metadata value from our $key param
 	 *

apps/files_versions/lib/Versions/IVersionManager.php

@@ -25,6 +25,10 @@
  */
 namespace OCA\Files_Versions\Versions;
 
+use OCP\Files\Node;
+use OCP\Files\Storage\IStorage;
+use OCP\IUser;
+
 /**
  * @since 15.0.0
  */
@@ -37,4 +41,21 @@ interface IVersionManager extends IVersionBackend {
 	 * @since 15.0.0
 	 */
 	public function registerBackend(string $storageType, IVersionBackend $backend);
+
+	/**
+	 * @param IStorage $storage
+	 * @return IVersionBackend
+	 * @throws BackendNotFoundException
+	 */
+	public function getBackendForStorage(IStorage $storage): IVersionBackend;
+
+	/**
+	 * Move versions across different backends
+	 *
+	 * @param IUser $user
+	 * @param Node $source
+	 * @param Node $target
+	 * @since 29.0.0
+	 */
+	public function moveVersionsAcrossBackends(IUser $user, Node $source, Node $target): void;
 }

apps/files_versions/lib/Versions/IVersionsImporterBackend.php

@@ -0,0 +1,50 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2024 Louis Chmn <louis@chmn.me>
+ *
+ * @author Louis Chmn <louis@chmn.me>
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ *
+ */
+namespace OCA\Files_Versions\Versions;
+
+use OCP\Files\Node;
+use OCP\IUser;
+
+/**
+ * @since 29.0.0
+ */
+interface IVersionsImporterBackend {
+	/**
+	 * Import the given versions for the target file.
+	 *
+	 * @param Node $target - The target is not yet created.
+	 * @param IVersion[] $versions
+	 * @since 29.0.0
+	 */
+	public function importVersionsForFile(IUser $user, Node $source, Node $target, array $versions): void;
+
+	/**
+	 * Clear all versions for a file
+	 *
+	 * @since 29.0.0
+	 */
+	public function clearVersionsForFile(IUser $user, Node $node): void;
+}

apps/files_versions/lib/Versions/LegacyVersionsBackend.php

@@ -27,6 +27,7 @@
 
 namespace OCA\Files_Versions\Versions;
 
+use Exception;
 use OC\Files\View;
 use OCA\DAV\Connector\Sabre\Exception\Forbidden;
 use OCA\Files_Sharing\ISharedStorage;
@@ -46,7 +47,7 @@
 use OCP\IUserManager;
 use OCP\IUserSession;
 
-class LegacyVersionsBackend implements IVersionBackend, IDeletableVersionBackend, INeedSyncVersionBackend, IMetadataVersionBackend {
+class LegacyVersionsBackend implements IVersionBackend, IDeletableVersionBackend, INeedSyncVersionBackend, IMetadataVersionBackend, IVersionsImporterBackend {
 	public function __construct(
 		private IRootFolder $rootFolder,
 		private IUserManager $userManager,
@@ -296,4 +297,69 @@ public function setMetadataValue(Node $node, int $revision, string $key, string
 		$versionEntity->setMetadataValue($key, $value);
 		$this->versionsMapper->update($versionEntity);
 	}
+
+
+	/**
+	 * @inheritdoc
+	 */
+	public function importVersionsForFile(IUser $user, Node $source, Node $target, array $versions): void {
+		$userFolder = $this->rootFolder->getUserFolder($user->getUID());
+		$relativePath = $userFolder->getRelativePath($target->getPath());
+
+		if ($relativePath === null) {
+			throw new \Exception('Target does not have a relative path' . $target->getPath());
+		}
+
+		$userView = new View('/' . $user->getUID());
+		// create all parent folders
+		// Storage::createMissingDirectories($relativePath, $userView);
+		Storage::scheduleExpire($user->getUID(), $relativePath);
+
+		foreach ($versions as $version) {
+			// 1. Move the file to the new location
+			if ($version->getTimestamp() !== $source->getMTime()) {
+				$backend = $version->getBackend();
+				$versionFile = $backend->getVersionFile($user, $source, $version->getRevisionId());
+				$newVersionPath = 'files_versions/' . $relativePath . '.v' . $version->getTimestamp();
+
+				$versionContent = $versionFile->fopen('r');
+				if ($versionContent === false) {
+					throw new Exception('Fail to open version file.');
+				}
+
+				$userView->file_put_contents($newVersionPath, $versionContent);
+				$userView->getFileInfo($newVersionPath);
+			}
+
+			// 2. Create the entity in the database
+			$versionEntity = new VersionEntity();
+			$versionEntity->setFileId($source->getId());
+			$versionEntity->setTimestamp($version->getTimestamp());
+			$versionEntity->setSize($version->getSize());
+			$versionEntity->setMimetype($this->mimeTypeLoader->getId($version->getMimetype()));
+			if ($version instanceof IMetadataVersion) {
+				$versionEntity->setMetadata($version->getMetadata());
+			}
+			$this->versionsMapper->insert($versionEntity);
+		}
+	}
+
+	/**
+	 * @inheritdoc
+	 */
+	public function clearVersionsForFile(IUser $user, Node $node): void {
+		$userFolder = $this->rootFolder->getUserFolder($user->getUID());
+
+		$relativePath = $userFolder->getRelativePath($node->getPath());
+		if ($relativePath === null) {
+			throw new Exception("Relative path not found for node with path: " . $node->getPath());
+		}
+
+		$versions = Storage::getVersions($user->getUID(), $relativePath);
+		foreach ($versions as $v) {
+			Storage::deleteRevision($relativePath, (int)$v['version']);
+		}
+
+		$this->versionsMapper->deleteAllVersionsForFileId($node->getId());
+	}
 }

apps/files_versions/lib/Versions/Version.php

@@ -79,6 +79,10 @@ public function getUser(): IUser {
 		return $this->user;
 	}
 
+	public function getMetadata(): array {
+		return $this->metadata;
+	}
+
 	public function getMetadataValue(string $key): ?string {
 		return $this->metadata[$key] ?? null;
 	}

apps/files_versions/lib/Versions/VersionManager.php

@@ -204,4 +204,41 @@ private static function handleAppLocks(callable $callback): ?bool {
 		}
 	}
 
+	/**
+	 * TODO: test
+	 *   - share to share - Should not move - OK
+	 *   - share to home - Should not move - OK
+	 *   - home to share - Should not move - OK
+	 *   - home to home - Should not move - OK
+	 *   - groupfolder to home - Should move
+	 *   - home to groupfolder - Should move
+	 *   - groupfolder to share - Should move
+	 *   - share to groupfolder - Should move
+	 *   - home to s3 - Should not move
+	 *   - s3 to home - Should move
+	 *   - s3 to groupfolder - Should move
+	 *   - groupfolder to s3 - Should not move
+	 */
+	public function moveVersionsAcrossBackends(IUser $user, Node $source, Node $target): void {
+		$sourceStorage = $source->getStorage();
+		// Look at the parent because the node itself does not exist yet.
+		$targetStorage = $target->getParent()->getStorage();
+
+		$sourceBackend = $this->getBackendForStorage($sourceStorage);
+		$targetBackend = $this->getBackendForStorage($targetStorage);
+
+		// If same storage, nothing to do
+		if ($sourceBackend === $targetBackend) {
+			return;
+		}
+
+		if ($targetBackend instanceof IVersionsImporterBackend) {
+			$versions = $sourceBackend->getVersionsForFile($user, $source);
+			$targetBackend->importVersionsForFile($user, $source, $target, $versions);
+		}
+
+		if ($sourceBackend instanceof IVersionsImporterBackend) {
+			$sourceBackend->clearVersionsForFile($user, $source);
+		}
+	}
 }

cypress/e2e/files/FilesUtils.ts

@@ -119,3 +119,9 @@ export const navigateToFolder = (folderName: string) => {
 export const closeSidebar = () => {
 	cy.get('[cy-data-sidebar] .app-sidebar__close').click()
 }
+
+export const clickOnBreadcumbs = (label: string) => {
+	cy.intercept('PROPFIND', /\/remote.php\/dav\//).as('propfind')
+	cy.get('[data-cy-files-content-breadcrumbs]').contains(label).click()
+	cy.wait('@propfind')
+}