wbrawner/server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fixes for encoding wrapper

Browse source 
Improved label
Fixed rename/copy/moveFromStorage/copyFromStorage and added tests
Improved findPathToUse algo
This commit is contained in:
Vincent Petry 2016-05-19 16:38:28 +02:00
parent f8b2b95408
commit e8d082208d
No known key found for this signature in database
GPG key ID: AF8F9EFC56562186
4 changed files with 72 additions and 44 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
apps/files_external/js/settings.js
View file

@ -35,7 +35,7 @@ var MOUNT_OPTIONS_DROPDOWN_TEMPLATE =
' </div>' +
' <div class="optionRow">' +
' <input id="mountOptionsEncoding" name="encoding_compatibility" type="checkbox" value="true"/>' +
' <label for="mountOptionsEncoding">{{t "files_external" "Enable encoding compatibility (decreases performance)"}}</label>' +
' <label for="mountOptionsEncoding">{{mountOptionsEncodingLabel}}</label>' +
' </div>' +
'</div>';
@ -493,7 +493,9 @@ MountOptionsDropdown.prototype = {
MountOptionsDropdown._template = template;
}
var $el = $(template());
var $el = $(template({
mountOptionsEncodingLabel: t('files_external', 'Compatibility with Mac NFD encoding (slow)')
}));
this.$el = $el;
this.setOptions(mountOptions, visibleOptions);

1
apps/files_external/templates/settings.php
View file

@ -10,7 +10,6 @@
$l->t("Check for changes");
$l->t("Never");
$l->t("Once every direct access");
$l->t("Enable encoding compatibility (decreases performance)");
script('files_external', 'settings');
style('files_external', 'settings');

60
lib/private/Files/Storage/Wrapper/Encoding.php
View file

@ -53,12 +53,7 @@ class Encoding extends Wrapper {
* @return bool true if the string is all ASCII, false otherwise
*/
private function isAscii($str) {
foreach (str_split($str) as $s) {
if (ord($s) > 127) {
return false;
}
}
return true;
return (bool) !preg_match('/[\\x80-\\xff]+/', $str);
}
/**
@ -79,8 +74,7 @@ class Encoding extends Wrapper {
$sections = explode('/', $fullPath);
$path = '';
foreach ($sections as $section) {
$path .= $section;
$convertedPath = $this->findPathToUseLastSection($path);
$convertedPath = $this->findPathToUseLastSection($path, $section);
if ($convertedPath === null) {
// no point in continuing if the section was not found, use original path
return $fullPath;
@ -88,7 +82,6 @@ class Encoding extends Wrapper {
$path = $convertedPath . '/';
}
$path = rtrim($path, '/');
$this->namesCache[$fullPath] = $path;
return $path;
}
@ -96,39 +89,28 @@ class Encoding extends Wrapper {
* Checks whether the last path section of the given path exists in NFC or NFD form
* and returns the correct form. If no existing path found, returns null.
*
* @param string $fullPath path to check
* @param string $basePath base path to check
* @param string $lastSection last section of the path to check for NFD/NFC variations
*
* @return string|null original or converted path, or null if none of the forms was found
*/
private function findPathToUseLastSection($fullPath) {
$cachedPath = $this->namesCache[$fullPath];
if ($cachedPath !== null) {
return $cachedPath;
}
$sections = explode('/', $fullPath);
$lastSection = array_pop($sections);
$basePath = ltrim(implode('/', $sections) . '/', '/');
if ($lastSection === '' || $this->isAscii($lastSection)) {
private function findPathToUseLastSection($basePath, $lastSection) {
$fullPath = $basePath . $lastSection;
if ($lastSection === '' || $this->isAscii($lastSection) || $this->storage->file_exists($fullPath)) {
$this->namesCache[$fullPath] = $fullPath;
return $fullPath;
}
$result = $this->storage->file_exists($fullPath);
if ($result) {
$this->namesCache[$fullPath] = $fullPath;
return $fullPath;
}
// swap encoding
if (\Normalizer::isNormalized($lastSection, \Normalizer::FORM_C)) {
$otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_D);
} else {
$otherFormPath = \Normalizer::normalize($lastSection, \Normalizer::FORM_C);
}
if ($this->storage->file_exists($basePath . $otherFormPath)) {
$this->namesCache[$fullPath] = $basePath . $otherFormPath;
return $basePath . $otherFormPath;
$otherFullPath = $basePath . $otherFormPath;
if ($this->storage->file_exists($otherFullPath)) {
$this->namesCache[$fullPath] = $otherFullPath;
return $otherFullPath;
}
// return original path, file did not exist at all
@ -146,7 +128,7 @@ class Encoding extends Wrapper {
// note: no conversion here, method should not be called with non-NFC names!
$result = $this->storage->mkdir($path);
if ($result) {
unset($this->namesCache[$path]);
$this->namesCache[$path] = $path;
}
return $result;
}
@ -326,11 +308,7 @@ class Encoding extends Wrapper {
* @return bool
*/
public function file_put_contents($path, $data) {
$result = $this->storage->file_put_contents($this->findPathToUse($path), $data);
if ($result) {
unset($this->namesCache[$path]);
}
return $result;
return $this->storage->file_put_contents($this->findPathToUse($path), $data);
}
/**
@ -356,7 +334,7 @@ class Encoding extends Wrapper {
*/
public function rename($path1, $path2) {
// second name always NFC
$result = $this->storage->rename($this->findPathToUse($path1), $path2);
$result = $this->storage->rename($this->findPathToUse($path1), $this->findPathToUse($path2));
if ($result) {
unset($this->namesCache[$path1]);
unset($this->namesCache[$path2]);
@ -372,7 +350,7 @@ class Encoding extends Wrapper {
* @return bool
*/
public function copy($path1, $path2) {
$result = $this->storage->copy($this->findPathToUse($path1), $path2);
$result = $this->storage->copy($this->findPathToUse($path1), $this->findPathToUse($path2));
if ($result) {
unset($this->namesCache[$path2]);
}
@ -524,10 +502,10 @@ class Encoding extends Wrapper {
*/
public function copyFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
if ($sourceStorage === $this) {
return $this->copy($this->findPathToUse($sourceInternalPath), $targetInternalPath);
return $this->copy($sourceInternalPath, $this->findPathToUse($targetInternalPath));
}
$result = $this->storage->copyFromStorage($sourceStorage, $this->findPathToUse($sourceInternalPath), $targetInternalPath);
$result = $this->storage->copyFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
if ($result) {
unset($this->namesCache[$targetInternalPath]);
}
@ -542,7 +520,7 @@ class Encoding extends Wrapper {
*/
public function moveFromStorage(\OCP\Files\Storage $sourceStorage, $sourceInternalPath, $targetInternalPath) {
if ($sourceStorage === $this) {
$result = $this->rename($this->findPathToUse($sourceInternalPath), $targetInternalPath);
$result = $this->rename($sourceInternalPath, $this->findPathToUse($targetInternalPath));
if ($result) {
unset($this->namesCache[$sourceInternalPath]);
unset($this->namesCache[$targetInternalPath]);
@ -550,7 +528,7 @@ class Encoding extends Wrapper {
return $result;
}
$result = $this->storage->moveFromStorage($sourceStorage, $this->findPathToUse($sourceInternalPath), $targetInternalPath);
$result = $this->storage->moveFromStorage($sourceStorage, $sourceInternalPath, $this->findPathToUse($targetInternalPath));
if ($result) {
unset($this->namesCache[$sourceInternalPath]);
unset($this->namesCache[$targetInternalPath]);

49
tests/lib/files/storage/wrapper/Encoding.php
View file

@ -151,4 +151,53 @@ class Encoding extends \Test\Files\Storage\Storage {
$this->assertEquals(8, $this->instance->file_put_contents('/' . self::NFC_NAME, 'barbaric'));
$this->assertEquals('barbaric', $this->instance->file_get_contents('//' . self::NFC_NAME));
}
public function sourceAndTargetDirectoryProvider() {
return [
[self::NFC_NAME . '1', self::NFC_NAME . '2'],
[self::NFD_NAME . '1', self::NFC_NAME . '2'],
[self::NFC_NAME . '1', self::NFD_NAME . '2'],
[self::NFD_NAME . '1', self::NFD_NAME . '2'],
];
}
/**
* @dataProvider sourceAndTargetDirectoryProvider
*/
public function testCopyAndMoveEncodedFolder($sourceDir, $targetDir) {
$this->sourceStorage->mkdir($sourceDir);
$this->sourceStorage->mkdir($targetDir);
$this->sourceStorage->file_put_contents($sourceDir . '/test.txt', 'bar');
$this->assertTrue($this->instance->copy(self::NFC_NAME . '1/test.txt', self::NFC_NAME . '2/test.txt'));
$this->assertTrue($this->instance->file_exists(self::NFC_NAME . '1/test.txt'));
$this->assertTrue($this->instance->file_exists(self::NFC_NAME . '2/test.txt'));
$this->assertEquals('bar', $this->instance->file_get_contents(self::NFC_NAME . '2/test.txt'));
$this->assertTrue($this->instance->rename(self::NFC_NAME . '1/test.txt', self::NFC_NAME . '2/test2.txt'));
$this->assertFalse($this->instance->file_exists(self::NFC_NAME . '1/test.txt'));
$this->assertTrue($this->instance->file_exists(self::NFC_NAME . '2/test2.txt'));
$this->assertEquals('bar', $this->instance->file_get_contents(self::NFC_NAME . '2/test2.txt'));
}
/**
* @dataProvider sourceAndTargetDirectoryProvider
*/
public function testCopyAndMoveFromStorageEncodedFolder($sourceDir, $targetDir) {
$this->sourceStorage->mkdir($sourceDir);
$this->sourceStorage->mkdir($targetDir);
$this->sourceStorage->file_put_contents($sourceDir . '/test.txt', 'bar');
$this->assertTrue($this->instance->copyFromStorage($this->instance, self::NFC_NAME . '1/test.txt', self::NFC_NAME . '2/test.txt'));
$this->assertTrue($this->instance->file_exists(self::NFC_NAME . '1/test.txt'));
$this->assertTrue($this->instance->file_exists(self::NFC_NAME . '2/test.txt'));
$this->assertEquals('bar', $this->instance->file_get_contents(self::NFC_NAME . '2/test.txt'));
$this->assertTrue($this->instance->moveFromStorage($this->instance, self::NFC_NAME . '1/test.txt', self::NFC_NAME . '2/test2.txt'));
$this->assertFalse($this->instance->file_exists(self::NFC_NAME . '1/test.txt'));
$this->assertTrue($this->instance->file_exists(self::NFC_NAME . '2/test2.txt'));
$this->assertEquals('bar', $this->instance->file_get_contents(self::NFC_NAME . '2/test2.txt'));
}
}