[stable26] fix: write object to the correct urn when moving from another storage to object store

lib/private/Files/ObjectStore/ObjectStoreStorage.php

@@ -581,6 +581,78 @@
 		return parent::copyFromStorage($sourceStorage, $sourceInternalPath, $targetInternalPath);
 	}
 
+	public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $targetInternalPath, ?ICacheEntry $sourceCacheEntry = null): bool {
+		$sourceCache = $sourceStorage->getCache();
+		if ($sourceStorage->instanceOfStorage(ObjectStoreStorage::class) && $sourceStorage->getObjectStore()->getStorageId() === $this->getObjectStore()->getStorageId()) {
+			$this->getCache()->moveFromCache($sourceCache, $sourceInternalPath, $targetInternalPath);
+			// Do not import any data when source and target bucket are identical.
+			return true;
+		}
+		if (!$sourceCacheEntry) {
+			$sourceCacheEntry = $sourceCache->get($sourceInternalPath);
+		}
+
+		$this->copyObjects($sourceStorage, $sourceCache, $sourceCacheEntry);
+		if ($sourceStorage->instanceOfStorage(ObjectStoreStorage::class)) {
+			/** @var ObjectStoreStorage $sourceStorage */
+			$sourceStorage->setPreserveCacheOnDelete(true);
+		}
+		if ($sourceCacheEntry->getMimeType() === ICacheEntry::DIRECTORY_MIMETYPE) {
+			$sourceStorage->rmdir($sourceInternalPath);
+		} else {
+			$sourceStorage->unlink($sourceInternalPath);
+		}
+		if ($sourceStorage->instanceOfStorage(ObjectStoreStorage::class)) {
+			/** @var ObjectStoreStorage $sourceStorage */
+			$sourceStorage->setPreserveCacheOnDelete(false);
+		}
+		$this->getCache()->moveFromCache($sourceCache, $sourceInternalPath, $targetInternalPath);
+
+		return true;
+	}
+
+	/**
+	 * Copy the object(s) of a file or folder into this storage, without touching the cache
+	 */
+	private function copyObjects(IStorage $sourceStorage, ICache $sourceCache, ICacheEntry $sourceCacheEntry) {
+		$copiedFiles = [];
+		try {
+			foreach ($this->getAllChildObjects($sourceCache, $sourceCacheEntry) as $file) {
+				$sourceStream = $sourceStorage->fopen($file->getPath(), 'r');
+				if (!$sourceStream) {
+					throw new \Exception("Failed to open source file {$file->getPath()} ({$file->getId()})");
+				}
+				$this->objectStore->writeObject($this->getURN($file->getId()), $sourceStream, $file->getMimeType());
+				if (is_resource($sourceStream)) {
+					fclose($sourceStream);
+				}
+				$copiedFiles[] = $file->getId();
+			}
+		} catch (\Exception $e) {
+			foreach ($copiedFiles as $fileId) {
+				try {
+					$this->objectStore->deleteObject($this->getURN($fileId));
+				} catch (\Exception $e) {
+					// ignore
+				}
+			}
+			throw $e;
+		}
+	}
+
+	/**
+	 * @return \Iterator<ICacheEntry>
+	 */
+	private function getAllChildObjects(ICache $cache, ICacheEntry $entry): \Iterator {
+		if ($entry->getMimeType() === FileInfo::MIMETYPE_FOLDER) {
+			foreach ($cache->getFolderContentsById($entry->getId()) as $child) {
+				yield from $this->getAllChildObjects($cache, $child);
+			}
+		} else {
+			yield $entry;
+		}
+	}
+
 	public function copy($source, $target) {
 		$source = $this->normalizePath($source);
 		$target = $this->normalizePath($target);

tests/lib/Files/ObjectStore/ObjectStoreStoragesDifferentBucketTest.php

@@ -0,0 +1,41 @@
+<?php
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace Test\Files\ObjectStore;
+
+use OC\Files\ObjectStore\StorageObjectStore;
+use OC\Files\Storage\Temporary;
+use Test\Files\Storage\StoragesTest;
+
+/**
+ * @group DB
+ */
+class ObjectStoreStoragesDifferentBucketTest extends StoragesTest {
+	/**
+	 * @var \OCP\Files\ObjectStore\IObjectStore
+	 */
+	private $objectStore1;
+
+	/**
+	 * @var \OCP\Files\ObjectStore\IObjectStore
+	 */
+	private $objectStore2;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$baseStorage1 = new Temporary();
+		$this->objectStore1 = new StorageObjectStore($baseStorage1);
+		$config['objectstore'] = $this->objectStore1;
+		$this->storage1 = new ObjectStoreStorageOverwrite($config);
+
+		$baseStorage2 = new Temporary();
+		$this->objectStore2 = new StorageObjectStore($baseStorage2);
+		$config['objectstore'] = $this->objectStore2;
+		$this->storage2 = new ObjectStoreStorageOverwrite($config);
+	}
+}

tests/lib/Files/ObjectStore/ObjectStoreStoragesSameBucketTest.php

@@ -0,0 +1,33 @@
+<?php
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace Test\Files\ObjectStore;
+
+use OC\Files\ObjectStore\StorageObjectStore;
+use OC\Files\Storage\Temporary;
+use Test\Files\Storage\StoragesTest;
+
+/**
+ * @group DB
+ */
+class ObjectStoreStoragesSameBucketTest extends StoragesTest {
+	/**
+	 * @var \OCP\Files\ObjectStore\IObjectStore
+	 */
+	private $objectStore;
+
+	protected function setUp(): void {
+		parent::setUp();
+
+		$baseStorage = new Temporary();
+		$this->objectStore = new StorageObjectStore($baseStorage);
+		$config['objectstore'] = $this->objectStore;
+		// storage1 and storage2 share the same object store.
+		$this->storage1 = new ObjectStoreStorageOverwrite($config);
+		$this->storage2 = new ObjectStoreStorageOverwrite($config);
+	}
+}

tests/lib/Files/Storage/StoragesTest.php

@@ -0,0 +1,108 @@
+<?php
+/**
+ * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace Test\Files\Storage;
+
+use Test\TestCase;
+
+abstract class StoragesTest extends TestCase {
+	/**
+	 * @var \OC\Files\Storage\Storage
+	 */
+	protected $storage1;
+
+	/**
+	 * @var \OC\Files\Storage\Storage
+	 */
+	protected $storage2;
+
+	protected function tearDown(): void {
+		if (is_null($this->storage1) && is_null($this->storage2)) {
+			return;
+		}
+		$this->storage1->getCache()->clear();
+		$this->storage2->getCache()->clear();
+
+		parent::tearDown();
+	}
+
+	public function testMoveFileFromStorage() {
+		$source = 'source.txt';
+		$target = 'target.txt';
+		$this->storage2->file_put_contents($source, 'foo');
+
+		$this->storage1->moveFromStorage($this->storage2, $source, $target);
+
+		$this->assertTrue($this->storage1->file_exists($target), $target.' was not created');
+		$this->assertFalse($this->storage2->file_exists($source), $source.' still exists');
+		$this->assertEquals('foo', $this->storage1->file_get_contents($target));
+	}
+
+	public function testMoveDirectoryFromStorage() {
+		$this->storage2->mkdir('source');
+		$this->storage2->file_put_contents('source/test1.txt', 'foo');
+		$this->storage2->file_put_contents('source/test2.txt', 'qwerty');
+		$this->storage2->mkdir('source/subfolder');
+		$this->storage2->file_put_contents('source/subfolder/test.txt', 'bar');
+
+		$this->storage1->moveFromStorage($this->storage2, 'source', 'target');
+
+		$this->assertTrue($this->storage1->file_exists('target'));
+		$this->assertTrue($this->storage1->file_exists('target/test1.txt'));
+		$this->assertTrue($this->storage1->file_exists('target/test2.txt'));
+		$this->assertTrue($this->storage1->file_exists('target/subfolder'));
+		$this->assertTrue($this->storage1->file_exists('target/subfolder/test.txt'));
+
+		$this->assertFalse($this->storage2->file_exists('source'));
+		$this->assertFalse($this->storage2->file_exists('source/test1.txt'));
+		$this->assertFalse($this->storage2->file_exists('source/test2.txt'));
+		$this->assertFalse($this->storage2->file_exists('source/subfolder'));
+		$this->assertFalse($this->storage2->file_exists('source/subfolder/test.txt'));
+
+		$this->assertEquals('foo', $this->storage1->file_get_contents('target/test1.txt'));
+		$this->assertEquals('qwerty', $this->storage1->file_get_contents('target/test2.txt'));
+		$this->assertEquals('bar', $this->storage1->file_get_contents('target/subfolder/test.txt'));
+	}
+
+	public function testCopyFileFromStorage() {
+		$source = 'source.txt';
+		$target = 'target.txt';
+		$this->storage2->file_put_contents($source, 'foo');
+
+		$this->storage1->copyFromStorage($this->storage2, $source, $target);
+
+		$this->assertTrue($this->storage1->file_exists($target), $target.' was not created');
+		$this->assertTrue($this->storage2->file_exists($source), $source.' was deleted');
+		$this->assertEquals('foo', $this->storage1->file_get_contents($target));
+	}
+
+	public function testCopyDirectoryFromStorage() {
+		$this->storage2->mkdir('source');
+		$this->storage2->file_put_contents('source/test1.txt', 'foo');
+		$this->storage2->file_put_contents('source/test2.txt', 'qwerty');
+		$this->storage2->mkdir('source/subfolder');
+		$this->storage2->file_put_contents('source/subfolder/test.txt', 'bar');
+
+		$this->storage1->copyFromStorage($this->storage2, 'source', 'target');
+
+		$this->assertTrue($this->storage1->file_exists('target'));
+		$this->assertTrue($this->storage1->file_exists('target/test1.txt'));
+		$this->assertTrue($this->storage1->file_exists('target/test2.txt'));
+		$this->assertTrue($this->storage1->file_exists('target/subfolder'));
+		$this->assertTrue($this->storage1->file_exists('target/subfolder/test.txt'));
+
+		$this->assertTrue($this->storage2->file_exists('source'));
+		$this->assertTrue($this->storage2->file_exists('source/test1.txt'));
+		$this->assertTrue($this->storage2->file_exists('source/test2.txt'));
+		$this->assertTrue($this->storage2->file_exists('source/subfolder'));
+		$this->assertTrue($this->storage2->file_exists('source/subfolder/test.txt'));
+
+		$this->assertEquals('foo', $this->storage1->file_get_contents('target/test1.txt'));
+		$this->assertEquals('qwerty', $this->storage1->file_get_contents('target/test2.txt'));
+		$this->assertEquals('bar', $this->storage1->file_get_contents('target/subfolder/test.txt'));
+	}
+}