Flatten structure of file-layout inside the export dir.

Before this PR all data-types (files, versions, trashbin...)
were stored inside a single files directory which closely followed ownClouds
home-folder layout. This allowed for fast iteration but also coupled
the format to ownCloud which in turn introduced some design quirks
(/files/files/) in files.jsonl (#111)

All data type specific folders are now stored in the root directory of
the export which allows simpler mapping from metadata (#118).
This is also reflected in the architecture: The exporter traverses down from
the specific directories instead from the home.

A special "root folder" was introduced in files.jsonl to further decouple things
from owncloud and to be able to carry the e-tag for the whole tree. Instead of
"/files", "/" is now root in the export.

Path class has been added to reduce path-merging boilerplate.

lib/Exporter.php

@@ -24,6 +24,7 @@
 
 use OCA\DataExporter\Extractor\FilesExtractor;
 use OCA\DataExporter\Extractor\MetadataExtractor;
+use OCA\DataExporter\Utilities\Path;
 use Symfony\Component\Filesystem\Filesystem;
 
 class Exporter {
@@ -56,15 +57,15 @@ public function __construct(Serializer $serializer, MetadataExtractor $metadataE
 	 * @return void
 	 */
 	public function export($uid, $exportDirectoryPath, $exportFiles = true) {
-		$exportPath = "$exportDirectoryPath/$uid";
+		$exportPath = Path::join($exportDirectoryPath, $uid);
 		$metaData = $this->metadataExtractor->extract($uid, $exportPath);
 		$this->filesystem->dumpFile(
-			"$exportPath/user.json",
+			Path::join($exportPath, '/user.json'),
 			$this->serializer->serialize($metaData)
 		);
 
 		if ($exportFiles) {
-			$filesPath = \ltrim("$exportPath/files");
+			$filesPath = Path::join($exportPath, 'files');
 			$this->filesExtractor->export($uid, $filesPath);
 		}
 	}

lib/Extractor/FilesExtractor.php

@@ -47,7 +47,7 @@ public function __construct(RecursiveNodeIteratorFactory $iteratorFactory, Files
 	 * @throws \OCP\Files\NotPermittedException
 	 */
 	public function export($userId, $exportPath) {
-		list($iterator, $baseFolder) = $this->iteratorFactory->getUserFolderParentRecursiveIterator($userId);
+		list($iterator, $baseFolder) = $this->iteratorFactory->getUserFolderRecursiveIterator($userId);
 		/** @var \OCP\Files\Node $node */
 		foreach ($iterator as $node) {
 			$nodePath = $node->getPath();

lib/Extractor/MetadataExtractor/FilesMetadataExtractor.php

@@ -24,8 +24,9 @@
 namespace OCA\DataExporter\Extractor\MetadataExtractor;
 
 use OC\User\NoUserException;
-use OCA\DataExporter\Utilities\Iterators\Nodes\RecursiveNodeIteratorFactory;
 use OCA\DataExporter\Model\File;
+use OCA\DataExporter\Utilities\Iterators\Nodes\RecursiveNodeIteratorFactory;
+use OCA\DataExporter\Utilities\Path;
 use OCA\DataExporter\Utilities\StreamHelper;
 use OCP\Files\Node;
 
@@ -56,17 +57,35 @@ public function __construct(RecursiveNodeIteratorFactory $iteratorFactory, Strea
 	 * @throws NoUserException
 	 */
 	public function extract($userId, $exportPath) {
-		list($iterator, $baseFolder) = $this->iteratorFactory->getUserFolderParentRecursiveIterator($userId);
+		list($iterator, $baseFolder) = $this->iteratorFactory->getUserFolderRecursiveIterator($userId);
 
-		$filename = $exportPath . '/' . $this::FILE_NAME;
+		$filename = Path::join($exportPath, $this::FILE_NAME);
 		$this->streamFile = $this->streamHelper->initStream($filename, 'ab', true);
 
+		// Write root folder entry first to preserve it's metadata
+		$rootFolder = (new File())
+			->setType(File::TYPE_FOLDER)
+			->setPath('/')
+			->setETag($baseFolder->getEtag())
+			->setMtime($baseFolder->getMTime())
+			->setPermissions($baseFolder->getPermissions());
+
+		$this->streamHelper->writelnToStream($this->streamFile, $rootFolder);
+
 		foreach ($iterator as $node) {
 			$nodePath = $node->getPath();
 			$relativePath = $baseFolder->getRelativePath($nodePath);
 
 			$file = new File();
 
+			if ("$relativePath/" === File::ROOT_FOLDER_PATH) {
+				$relativePath = '/';
+			}
+
+			if (\substr($relativePath, 0, \strlen(File::ROOT_FOLDER_PATH)) == File::ROOT_FOLDER_PATH) {
+				$relativePath = '/' . \substr($relativePath, \strlen(File::ROOT_FOLDER_PATH));
+			}
+
 			$file->setPath($relativePath);
 			$file->setETag($node->getEtag());
 			$file->setMtime($node->getMTime());

lib/Importer.php

@@ -26,6 +26,7 @@
 use OCA\DataExporter\Importer\ImportException;
 use OCA\DataExporter\Importer\MetadataImporter;
 use OCA\DataExporter\Model\Metadata;
+use OCA\DataExporter\Utilities\Path;
 use Symfony\Component\Filesystem\Filesystem;
 use OCA\DataExporter\Importer\FilesImporter;
 use OCA\DataExporter\Importer\MetadataImporter\ShareImporter;
@@ -67,10 +68,11 @@ public function __construct(
 	 * @throws \OCP\PreConditionNotMetException
 	 */
 	public function import($pathToExportDir, $alias = null) {
-		$metaDataPath = "$pathToExportDir/user.json";
+		$pathToExportDir =\rtrim($pathToExportDir, '\/');
+		$metaDataPath = Path::join($pathToExportDir, 'user.json');
 
 		if (!$this->filesystem->exists($metaDataPath)) {
-			throw new ImportException("user.json not found in '$metaDataPath'");
+			throw new ImportException("user.json not found in \'$metaDataPath\'");
 		}
 
 		/** @var Metadata $metadata */

lib/Importer/FilesImporter.php

@@ -27,6 +27,7 @@
 use OCA\DataExporter\Utilities\StreamHelper;
 use OCP\Files\IRootFolder;
 use Symfony\Component\Filesystem\Filesystem;
+use OCA\DataExporter\Utilities\Path;
 
 class FilesImporter {
 	const FILE_NAME = 'files.jsonl';
@@ -69,10 +70,10 @@ public function import($userId, $exportPath) {
 		/**
 		 * @var \OCP\Files\Folder $userFolder
 		 */
-		$filename = $exportPath . '/' . $this::FILE_NAME;
-		$exportRootFilesPath = $exportPath . '/files';
+		$filename = Path::join($exportPath, $this::FILE_NAME);
+		$exportRootFilesPath = Path::join($exportPath, '/files');
 
-		$userFolder = $this->rootFolder->getUserFolder($userId)->getParent();
+		$userFolder = $this->rootFolder->getUserFolder($userId);
 		$this->streamFile = $this
 			->streamHelper
 			->initStream($filename, 'rb');
@@ -90,15 +91,14 @@ public function import($userId, $exportPath) {
 				!== false
 			) {
 				$fileCachePath = $fileMetadata->getPath();
-				$pathToFileInExport = "$exportRootFilesPath/$fileCachePath";
+				$pathToFileInExport = Path::join($exportRootFilesPath, $fileCachePath);
 
 				if (!$this->filesystem->exists($pathToFileInExport)) {
 					throw new ImportException("File '$pathToFileInExport' not found in export but exists in metadata.json");
 				}
 
 				if ($fileMetadata->getType() === File::TYPE_FILE) {
 					$file = $userFolder->newFile($fileCachePath);
-
 					$src = \fopen($pathToFileInExport, "rb+");
 					if (!\is_resource($src)) {
 						throw new \RuntimeException("Couldn't read file in export $pathToFileInExport");
@@ -124,7 +124,11 @@ public function import($userId, $exportPath) {
 				}
 
 				if ($fileMetadata->getType() === File::TYPE_FOLDER) {
-					$folder = $userFolder->newFolder($fileCachePath);
+					if ($fileMetadata->getPath() == '/') {
+						$folder = $userFolder;
+					} else {
+						$folder = $userFolder->newFolder($fileCachePath);
+					}
 					$folder->getStorage()->getCache()->update($folder->getId(), [
 						'etag' => $fileMetadata->getETag(),
 						'permissions' => $fileMetadata->getPermissions()

lib/Model/File.php

@@ -32,6 +32,7 @@
 class File {
 	const TYPE_FOLDER = 'folder';
 	const TYPE_FILE = 'file';
+	const ROOT_FOLDER_PATH = '/files/';
 
 	private $type;
 	/** @var string */

lib/Utilities/Iterators/Nodes/RecursiveNodeIteratorFactory.php

@@ -64,45 +64,4 @@ public function getUserFolderRecursiveIterator($userId, $mode = \RecursiveIterat
 		$nodeIterator->addSkipCondition($conditionDifferentStorage);
 		return [new \RecursiveIteratorIterator($nodeIterator, $mode), $userFolder];
 	}
-
-	/**
-	 * Returns an array containing a recursive iterator to iterate over the files of the user as the first
-	 * element of the array, and the base Folder node used in the iterator as the second element. Something like:
-	 * [RecursiveIteratorIterator, Folder]
-	 * If the getUserFolderRecursiveIterator method will return an iterator over the files
-	 * of the user (/<user>/files/), this iterator will iterate over that parent folder
-	 * (/<user>/) so you could get access to trashbin and versions and maybe other directories
-	 * related the to user.
-	 * It will use a RecursiveIteratorIterator class wrapping a RecursiveNodeIterator class.
-	 * This RecursiveNodeIterator will return \OCP\Files\Node elements
-	 *
-	 * Note that a SkipNodeConditionDifferentStorage is already set in the iterator in order to traverse
-	 * only the primary storage, and also a SkipNodeConditionIgnorePath to skip some folders containing
-	 * temporary information
-	 *
-	 * Consider to use something like:
-	 * ```
-	 * list($iterator, $baseFolder) = $factory->getUserFolderParentRecursiveIterator($userId);
-	 * ```
-	 *
-	 * You can traverse the iterator like:
-	 * ```
-	 * foreach ($iterator as $key => $node) { .... }
-	 * ```
-	 * Note that the $key will always be the path of the node, the same as $node->getPath()
-	 * @param string $userId the id of the user
-	 * @param int $mode one of the \RecursiveIteratorIterator constants
-	 * @return array a RecursiveIteratorIterator wrapping a RecursiveNodeIterator and the base Folder node
-	 * @throws \OC\User\NoUserException (unhandled exception)
-	 */
-	public function getUserFolderParentRecursiveIterator($userId, $mode = \RecursiveIteratorIterator::SELF_FIRST) {
-		$userFolder = $this->rootFolder->getUserFolder($userId);
-		$parentFolder = $userFolder->getParent();
-		$nodeIterator = new RecursiveNodeIterator($parentFolder);
-		$conditionDifferentStorage = new SkipNodeConditionDifferentStorage($parentFolder->getStorage()->getId());
-		$conditionIgnorePaths = new SkipNodeConditionIgnorePath($parentFolder, ['/cache', '/thumbnails', '/uploads']);
-		$nodeIterator->addSkipCondition($conditionDifferentStorage);
-		$nodeIterator->addSkipCondition($conditionIgnorePaths);
-		return [new \RecursiveIteratorIterator($nodeIterator, $mode), $parentFolder];
-	}
 }

lib/Utilities/Path.php

@@ -0,0 +1,60 @@
+<?php
+/**
+ * @author Ilja Neumann <[email protected]>
+ *
+ * @copyright Copyright (c) 2019, ownCloud GmbH
+ * @license GPL-2.0
+ *
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General,
+ * Public License as published by the Free
+ * Software Foundation; either version 2 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 General Public License for
+ * more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ */
+namespace OCA\DataExporter\Utilities;
+
+class Path {
+	const REGEX = '#/+#';
+
+	/**
+	 * Joins paths, removes duplicate and adds missing slashes. Preservers
+	 * double slashes in the scheme part of the path e.g vfs://foo/bar
+	 *
+	 * @return string
+	 */
+	public static function join() {
+		$paths = [];
+
+		foreach (\func_get_args() as $arg) {
+			if ($arg !== '') {
+				$paths[] = $arg;
+			}
+		}
+
+		if (\count($paths) === 0) {
+			return '';
+		}
+
+		$firstPart = $paths[0];
+		$path = \preg_replace(self::REGEX, '/', \join('/', $paths));
+		$scheme = \parse_url($firstPart, PHP_URL_SCHEME);
+		$hasScheme =  \substr($firstPart, 0, \strlen("$scheme://")) === "$scheme://";
+		$slashWasRemoved = \substr($path, 0, \strlen("$scheme:/")) == "$scheme:/";
+
+		if ($hasScheme && $slashWasRemoved) {
+			$path = "$scheme://" . \substr($path, \strlen("$scheme:/"));
+		}
+
+		return $path;
+	}
+}

tests/unit/Extractor/FilesExtractorTest.php

@@ -66,7 +66,7 @@ public function testExportFile() {
 			}));
 
 		// iterator can return an array because will just need to traverse it
-		$this->iteratorFactory->method('getUserFolderParentRecursiveIterator')->willReturn([[$mockFile], $userFolderParent]);
+		$this->iteratorFactory->method('getUserFolderRecursiveIterator')->willReturn([[$mockFile], $userFolderParent]);
 
 		$this->filesExporter->export('usertest', '/tmp/randomF');
 		$content = \file_get_contents('/tmp/randomF/files/foo/bar.txt');
@@ -89,7 +89,7 @@ public function testExportFolder() {
 			}));
 
 		// iterator can return an array because will just need to traverse it
-		$this->iteratorFactory->method('getUserFolderParentRecursiveIterator')->willReturn([[$mockFolder], $userFolderParent]);
+		$this->iteratorFactory->method('getUserFolderRecursiveIterator')->willReturn([[$mockFolder], $userFolderParent]);
 
 		$this->filesystem->expects($this->once())
 			->method('mkdir')
@@ -134,7 +134,7 @@ public function testExportFileAndFolder() {
 			}));
 
 		// iterator can return an array because will just need to traverse it
-		$this->iteratorFactory->method('getUserFolderParentRecursiveIterator')
+		$this->iteratorFactory->method('getUserFolderRecursiveIterator')
 			->willReturn([[$mockFolder1, $mockFolder2, $mockFile1, $mockFile2], $userFolderParent]);
 
 		$this->filesystem->expects($this->exactly(2))

tests/unit/Extractor/MetadataExtractor/FilesMetadataExtractorTest.php

@@ -91,6 +91,10 @@ public function testExtract() {
 		$mockFile2->method('getType')->willReturn(Node::TYPE_FILE);
 
 		$userFolderParent = $this->createMock(Folder::class);
+		$userFolderParent->method('getEtag')->willReturn('123qweasdzxc');
+		$userFolderParent->method('getMTime')->willReturn(1565074220);
+		$userFolderParent->method('getPermissions')->willReturn(31);
+		$userFolderParent->method('getType')->willReturn(Node::TYPE_FOLDER);
 		$userFolderParent->method('getRelativePath')
 			->will($this->returnCallback(function ($path) {
 				if (\strpos($path, '/usertest/') === 0) {
@@ -101,41 +105,49 @@ public function testExtract() {
 			}));
 
 		// iterator can return an array because will just need to traverse it
-		$this->iteratorFactory->method('getUserFolderParentRecursiveIterator')
+		$this->iteratorFactory->method('getUserFolderRecursiveIterator')
 			->willReturn([[$mockFolder1, $mockFolder2, $mockFile1, $mockFile2], $userFolderParent]);
 
+		$expectedFolder0 = new File();
+		$expectedFolder0->setPath('/')
+			->setEtag('123qweasdzxc')
+			->setMtime(1565074220)
+			->setPermissions(31)
+			->setType(File::TYPE_FOLDER);
+
 		$expectedFolder1 = new File();
-		$expectedFolder1->setPath('/files/foo')
+		$expectedFolder1->setPath('/foo')
 			->setEtag('123qweasdzxc')
 			->setMtime(1565074220)
 			->setPermissions(31)
 			->setType(File::TYPE_FOLDER);
 
 		$expectedFolder2 = new File();
-		$expectedFolder2->setPath('/files/foo/courses')
+		$expectedFolder2->setPath('/foo/courses')
 			->setEtag('zaqxswcde')
 			->setMtime(1565074223)
 			->setPermissions(31)
 			->setType(File::TYPE_FOLDER);
 
 		$expectedFile1 = new File();
-		$expectedFile1->setPath('/files/foo/courses/awesome qwerty')
+		$expectedFile1->setPath('/foo/courses/awesome qwerty')
 			->setEtag('poiulkjhmnbv')
 			->setMtime(1565074221)
 			->setPermissions(1)
 			->setType(File::TYPE_FILE);
 
 		$expectedFile2 = new File();
-		$expectedFile2->setPath('/files/foo/bar.txt')
+		$expectedFile2->setPath('/foo/bar.txt')
 			->setEtag('123456789')
 			->setMtime(1565074120)
 			->setPermissions(9)
 			->setType(File::TYPE_FILE);
 
 		$this->streamHelper
-			->expects($this->exactly(4))
+			->expects($this->exactly(5))
 			->method('writelnToStream')
 			->withConsecutive(
+				[$resource, $expectedFolder0],
 				[$resource, $expectedFolder1],
 				[$resource, $expectedFolder2],
 				[$resource, $expectedFile1],