Normalize directory entries in Encoding wrapper

Directory entry file names are now normalized in getMetaData(),
getDirectoryContents() and opendir().

This makes the scanner work properly as it assumes pre-normalized names.

In case the names were not normalized, the scanner will now skip the
entries and display a warning when applicable.

Signed-off-by: Vincent Petry <[email protected]>

Author: PVince81

lib/composer/composer/autoload_classmap.php

@@ -1161,6 +1161,7 @@
     'OC\\Files\\Storage\\Temporary' => $baseDir . '/lib/private/Files/Storage/Temporary.php',
     'OC\\Files\\Storage\\Wrapper\\Availability' => $baseDir . '/lib/private/Files/Storage/Wrapper/Availability.php',
     'OC\\Files\\Storage\\Wrapper\\Encoding' => $baseDir . '/lib/private/Files/Storage/Wrapper/Encoding.php',
+    'OC\\Files\\Storage\\Wrapper\\EncodingDirectoryWrapper' => $baseDir . '/lib/private/Files/Storage/Wrapper/EncodingDirectoryWrapper.php',
     'OC\\Files\\Storage\\Wrapper\\Encryption' => $baseDir . '/lib/private/Files/Storage/Wrapper/Encryption.php',
     'OC\\Files\\Storage\\Wrapper\\Jail' => $baseDir . '/lib/private/Files/Storage/Wrapper/Jail.php',
     'OC\\Files\\Storage\\Wrapper\\PermissionsMask' => $baseDir . '/lib/private/Files/Storage/Wrapper/PermissionsMask.php',

lib/composer/composer/autoload_static.php

@@ -1190,6 +1190,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c
         'OC\\Files\\Storage\\Temporary' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Temporary.php',
         'OC\\Files\\Storage\\Wrapper\\Availability' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Wrapper/Availability.php',
         'OC\\Files\\Storage\\Wrapper\\Encoding' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Wrapper/Encoding.php',
+        'OC\\Files\\Storage\\Wrapper\\EncodingDirectoryWrapper' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Wrapper/EncodingDirectoryWrapper.php',
         'OC\\Files\\Storage\\Wrapper\\Encryption' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Wrapper/Encryption.php',
         'OC\\Files\\Storage\\Wrapper\\Jail' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Wrapper/Jail.php',
         'OC\\Files\\Storage\\Wrapper\\PermissionsMask' => __DIR__ . '/../../..' . '/lib/private/Files/Storage/Wrapper/PermissionsMask.php',

lib/private/Files/Cache/Scanner.php

@@ -422,9 +422,12 @@ private function handleChildren($path, $recursive, $reuse, $folderId, $lock, &$s
 			}
 			$originalFile = $fileMeta['name'];
 			$file = trim(\OC\Files\Filesystem::normalizePath($originalFile), '/');
-			if (trim($originalFile, '/') !== $file && !$this->storage->instanceOfStorage(Encoding::class)) {
+			if (trim($originalFile, '/') !== $file) {
 				// encoding mismatch, might require compatibility wrapper
+				\OC::$server->getLogger()->debug('Scanner: Skipping non-normalized file name "'. $originalFile . '" in path "' . $path . '".', ['app' => 'core']);
 				$this->emit('\OC\Files\Cache\Scanner', 'normalizedNameMismatch', [$path ? $path . '/' . $originalFile : $originalFile]);
+				// skip this entry
+				continue;
 			}
 
 			$newChildNames[] = $file;

lib/private/Files/Storage/Wrapper/Encoding.php

@@ -29,6 +29,7 @@
 namespace OC\Files\Storage\Wrapper;
 
 use OC\Cache\CappedMemoryCache;
+use OC\Files\Filesystem;
 use OCP\Files\Storage\IStorage;
 use OCP\ICache;
 
@@ -162,7 +163,8 @@ public function rmdir($path) {
 	 * @return resource|bool
 	 */
 	public function opendir($path) {
-		return $this->storage->opendir($this->findPathToUse($path));
+		$handle = $this->storage->opendir($this->findPathToUse($path));
+		return EncodingDirectoryWrapper::wrap($handle);
 	}
 
 	/**
@@ -532,10 +534,16 @@ public function moveFromStorage(IStorage $sourceStorage, $sourceInternalPath, $t
 	}
 
 	public function getMetaData($path) {
-		return $this->storage->getMetaData($this->findPathToUse($path));
+		$entry = $this->storage->getMetaData($this->findPathToUse($path));
+		$entry['name'] = trim(Filesystem::normalizePath($entry['name']), '/');
+		return $entry;
 	}
 
 	public function getDirectoryContent($directory): \Traversable {
-		return $this->storage->getDirectoryContent($this->findPathToUse($directory));
+		$entries = $this->storage->getDirectoryContent($this->findPathToUse($directory));
+		foreach ($entries as $entry) {
+			$entry['name'] = trim(Filesystem::normalizePath($entry['name']), '/');
+			yield $entry;
+		}
 	}
 }

lib/private/Files/Storage/Wrapper/EncodingDirectoryWrapper.php

@@ -0,0 +1,55 @@
+<?php
+/**
+ * @copyright Copyright (c) 2021, Nextcloud GmbH.
+ *
+ * @author Robin Appelman <[email protected]>
+ * @author Vincent Petry <[email protected]>
+ *
+ * @license AGPL-3.0
+ *
+ * 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 OC\Files\Storage\Wrapper;
+
+use Icewind\Streams\DirectoryWrapper;
+use OC\Files\Filesystem;
+
+/**
+ * Normalize file names while reading directory entries
+ */
+class EncodingDirectoryWrapper extends DirectoryWrapper {
+	/**
+	 * @return string
+	 */
+	public function dir_readdir() {
+		$file = readdir($this->source);
+		if ($file !== false && $file !== '.' && $file !== '..') {
+			$file = trim(Filesystem::normalizePath($file), '/');
+		}
+
+		return $file;
+	}
+
+	/**
+	 * @param resource $source
+	 * @param callable $filter
+	 * @return resource|bool
+	 */
+	public static function wrap($source) {
+		return self::wrapSource($source, [
+			'source' => $source,
+		]);
+	}
+}

tests/lib/Files/Storage/Wrapper/EncodingTest.php

@@ -32,7 +32,7 @@ protected function tearDown(): void {
 
 	public function directoryProvider() {
 		$a = parent::directoryProvider();
-		$a[] = [self::NFD_NAME];
+		$a[] = [self::NFC_NAME];
 		return $a;
 	}
 
@@ -199,4 +199,46 @@ public function testCopyAndMoveFromStorageEncodedFolder($sourceDir, $targetDir)
 
 		$this->assertEquals('bar', $this->instance->file_get_contents(self::NFC_NAME . '2/test2.txt'));
 	}
+
+	public function testNormalizedDirectoryEntriesOpenDir() {
+		$this->sourceStorage->mkdir('/test');
+		$this->sourceStorage->mkdir('/test/' . self::NFD_NAME);
+
+		$this->assertTrue($this->instance->file_exists('/test/' . self::NFC_NAME));
+		$this->assertTrue($this->instance->file_exists('/test/' . self::NFD_NAME));
+
+		$dh = $this->instance->opendir('/test');
+		$content = [];
+		while ($file = readdir($dh)) {
+			if ($file != '.' and $file != '..') {
+				$content[] = $file;
+			}
+		}
+
+		$this->assertCount(1, $content);
+		$this->assertEquals(self::NFC_NAME, $content[0]);
+	}
+
+	public function testNormalizedDirectoryEntriesGetDirectoryContent() {
+		$this->sourceStorage->mkdir('/test');
+		$this->sourceStorage->mkdir('/test/' . self::NFD_NAME);
+
+		$this->assertTrue($this->instance->file_exists('/test/' . self::NFC_NAME));
+		$this->assertTrue($this->instance->file_exists('/test/' . self::NFD_NAME));
+
+		$content = iterator_to_array($this->instance->getDirectoryContent('/test'));
+		$this->assertCount(1, $content);
+		$this->assertEquals(self::NFC_NAME, $content[0]['name']);
+	}
+
+	public function testNormalizedGetMetaData() {
+		$this->sourceStorage->mkdir('/test');
+		$this->sourceStorage->mkdir('/test/' . self::NFD_NAME);
+
+		$entry = $this->instance->getMetaData('/test/' . self::NFC_NAME);
+		$this->assertEquals(self::NFC_NAME, $entry['name']);
+
+		$entry = $this->instance->getMetaData('/test/' . self::NFD_NAME);
+		$this->assertEquals(self::NFC_NAME, $entry['name']);
+	}
 }