sascha
/
nextcloud-server
mirror of https://github.com/nextcloud/server.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <vincent@nextcloud.com>
pull/29794/head
Vincent Petry 2021-11-17 09:19:10 +07:00 committed by backportbot[bot]
parent 88b5860e70
commit ca37664887
6 changed files with 115 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
lib/composer/composer/autoload_classmap.php
Unescape Escape View File

@ -1131,6 +1131,7 @@ return array(
'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',

1
lib/composer/composer/autoload_static.php
Unescape Escape View File

@ -1160,6 +1160,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',

5
lib/private/Files/Cache/Scanner.php
Unescape Escape View File

@ -423,9 +423,12 @@ class Scanner extends BasicEmitter implements IScanner {
}
$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;

14
lib/private/Files/Storage/Wrapper/Encoding.php
Unescape Escape View File

@ -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 @@ class Encoding extends Wrapper {
* @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 @@ class Encoding extends Wrapper {
}
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;
}
}
}

55
lib/private/Files/Storage/Wrapper/EncodingDirectoryWrapper.php
Unescape Escape View File

@ -0,0 +1,55 @@
<?php
/**
* @copyright Copyright (c) 2021, Nextcloud GmbH.
*
* @author Robin Appelman <robin@icewind.nl>
* @author Vincent Petry <vincent@nextcloud.com>
*
* @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,
]);
}
}

44
tests/lib/Files/Storage/Wrapper/EncodingTest.php
Unescape Escape View File

@ -32,7 +32,7 @@ class EncodingTest extends \Test\Files\Storage\Storage {
public function directoryProvider() {
$a = parent::directoryProvider();
$a[] = [self::NFD_NAME];
$a[] = [self::NFC_NAME];
return $a;
}
@ -199,4 +199,46 @@ class EncodingTest extends \Test\Files\Storage\Storage {
$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']);
}
}