nextcloud/tests/lib/Files/FilesystemTest.php

475 lines
14 KiB
PHP
Raw Normal View History

2012-10-26 20:07:01 +04:00
<?php
/**
* ownCloud
*
* @author Robin Appelman
* @copyright 2012 Robin Appelman icewind@owncloud.com
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library 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 along with this library. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace Test\Files;
use OC\Files\Mount\MountPoint;
use OC\Files\Storage\Temporary;
use OC\User\NoUserException;
use OCP\Files\Config\IMountProvider;
use OCP\Files\Storage\IStorageFactory;
use OCP\IUser;
class DummyMountProvider implements IMountProvider {
private $mounts = [];
/**
* @param array $mounts
*/
public function __construct(array $mounts) {
$this->mounts = $mounts;
}
2015-05-08 14:51:32 +03:00
/**
* Get the pre-registered mount points
*
* @param IUser $user
* @param IStorageFactory $loader
* @return \OCP\Files\Mount\IMountPoint[]
*/
public function getMountsForUser(IUser $user, IStorageFactory $loader) {
return isset($this->mounts[$user->getUID()]) ? $this->mounts[$user->getUID()] : [];
}
}
2015-11-03 03:52:41 +03:00
/**
* Class FilesystemTest
2015-11-03 03:52:41 +03:00
*
* @group DB
*
* @package Test\Files
*/
class FilesystemTest extends \Test\TestCase {
public const TEST_FILESYSTEM_USER1 = "test-filesystem-user1";
public const TEST_FILESYSTEM_USER2 = "test-filesystem-user1";
2015-04-09 15:03:30 +03:00
2012-10-26 20:07:01 +04:00
/**
* @var array tmpDirs
*/
private $tmpDirs = [];
2012-10-26 20:07:01 +04:00
/**
* @return array
*/
private function getStorageData() {
2015-12-18 13:19:53 +03:00
$dir = \OC::$server->getTempManager()->getTemporaryFolder();
2012-10-26 20:07:01 +04:00
$this->tmpDirs[] = $dir;
return ['datadir' => $dir];
2012-10-26 20:07:01 +04:00
}
protected function setUp(): void {
parent::setUp();
2015-09-22 01:56:36 +03:00
$userBackend = new \Test\Util\User\Dummy();
$userBackend->createUser(self::TEST_FILESYSTEM_USER1, self::TEST_FILESYSTEM_USER1);
$userBackend->createUser(self::TEST_FILESYSTEM_USER2, self::TEST_FILESYSTEM_USER2);
\OC::$server->getUserManager()->registerBackend($userBackend);
$this->loginAsUser();
}
protected function tearDown(): void {
2012-10-26 20:07:01 +04:00
foreach ($this->tmpDirs as $dir) {
\OC_Helper::rmdirr($dir);
}
$this->logout();
$this->invokePrivate('\OC\Files\Filesystem', 'normalizedPathCache', [null]);
parent::tearDown();
2012-10-26 20:07:01 +04:00
}
public function testMount() {
\OC\Files\Filesystem::mount('\OC\Files\Storage\Local', self::getStorageData(), '/');
$this->assertEquals('/', \OC\Files\Filesystem::getMountPoint('/'));
$this->assertEquals('/', \OC\Files\Filesystem::getMountPoint('/some/folder'));
list(, $internalPath) = \OC\Files\Filesystem::resolvePath('/');
$this->assertEquals('', $internalPath);
list(, $internalPath) = \OC\Files\Filesystem::resolvePath('/some/folder');
$this->assertEquals('some/folder', $internalPath);
\OC\Files\Filesystem::mount('\OC\Files\Storage\Local', self::getStorageData(), '/some');
$this->assertEquals('/', \OC\Files\Filesystem::getMountPoint('/'));
$this->assertEquals('/some/', \OC\Files\Filesystem::getMountPoint('/some/folder'));
$this->assertEquals('/some/', \OC\Files\Filesystem::getMountPoint('/some/'));
$this->assertEquals('/some/', \OC\Files\Filesystem::getMountPoint('/some'));
list(, $internalPath) = \OC\Files\Filesystem::resolvePath('/some/folder');
$this->assertEquals('folder', $internalPath);
2012-10-26 20:07:01 +04:00
}
public function normalizePathData() {
return [
['/', ''],
['/', '/'],
['/', '//'],
['/', '/', false],
['/', '//', false],
['/path', '/path/'],
['/path/', '/path/', false],
['/path', 'path'],
['/foo/bar', '/foo//bar/'],
['/foo/bar/', '/foo//bar/', false],
['/foo/bar', '/foo////bar'],
['/foo/bar', '/foo/////bar'],
['/foo/bar', '/foo/bar/.'],
['/foo/bar', '/foo/bar/./'],
['/foo/bar/', '/foo/bar/./', false],
['/foo/bar', '/foo/bar/./.'],
['/foo/bar', '/foo/bar/././'],
['/foo/bar/', '/foo/bar/././', false],
['/foo/bar', '/foo/./bar/'],
['/foo/bar/', '/foo/./bar/', false],
['/foo/.bar', '/foo/.bar/'],
['/foo/.bar/', '/foo/.bar/', false],
['/foo/.bar/tee', '/foo/.bar/tee'],
['/foo/bar', '/.///././//./foo/.///././//./bar/./././.'],
['/foo/bar/', '/.///././//./foo/.///././//./bar/./././.', false],
['/foo/bar', '/.///././//./foo/.///././//./bar/././././'],
['/foo/bar/', '/.///././//./foo/.///././//./bar/././././', false],
// Windows paths
['/', ''],
['/', '\\'],
['/', '\\', false],
['/', '\\\\'],
['/', '\\\\', false],
['/path', '\\path'],
['/path', '\\path', false],
['/path', '\\path\\'],
['/path/', '\\path\\', false],
['/foo/bar', '\\foo\\\\bar\\'],
['/foo/bar/', '\\foo\\\\bar\\', false],
['/foo/bar', '\\foo\\\\\\\\bar'],
['/foo/bar', '\\foo\\\\\\\\\\bar'],
['/foo/bar', '\\foo\\bar\\.'],
['/foo/bar', '\\foo\\bar\\.\\'],
['/foo/bar/', '\\foo\\bar\\.\\', false],
['/foo/bar', '\\foo\\bar\\.\\.'],
['/foo/bar', '\\foo\\bar\\.\\.\\'],
['/foo/bar/', '\\foo\\bar\\.\\.\\', false],
['/foo/bar', '\\foo\\.\\bar\\'],
['/foo/bar/', '\\foo\\.\\bar\\', false],
['/foo/.bar', '\\foo\\.bar\\'],
['/foo/.bar/', '\\foo\\.bar\\', false],
['/foo/.bar/tee', '\\foo\\.bar\\tee'],
// Absolute windows paths NOT marked as absolute
['/C:', 'C:\\'],
['/C:/', 'C:\\', false],
['/C:/tests', 'C:\\tests'],
['/C:/tests', 'C:\\tests', false],
['/C:/tests', 'C:\\tests\\'],
['/C:/tests/', 'C:\\tests\\', false],
['/C:/tests/bar', 'C:\\tests\\.\\.\\bar'],
['/C:/tests/bar/', 'C:\\tests\\.\\.\\bar\\.\\', false],
// normalize does not resolve '..' (by design)
['/foo/..', '/foo/../'],
['/foo/..', '\\foo\\..\\'],
];
}
/**
* @dataProvider normalizePathData
*/
public function testNormalizePath($expected, $path, $stripTrailingSlash = true) {
$this->assertEquals($expected, \OC\Files\Filesystem::normalizePath($path, $stripTrailingSlash));
}
public function normalizePathKeepUnicodeData() {
$nfdName = 'ümlaut';
$nfcName = 'ümlaut';
return [
['/' . $nfcName, $nfcName, true],
['/' . $nfcName, $nfcName, false],
['/' . $nfdName, $nfdName, true],
['/' . $nfcName, $nfdName, false],
];
}
/**
* @dataProvider normalizePathKeepUnicodeData
*/
public function testNormalizePathKeepUnicode($expected, $path, $keepUnicode = false) {
$this->assertEquals($expected, \OC\Files\Filesystem::normalizePath($path, true, false, $keepUnicode));
}
public function testNormalizePathKeepUnicodeCache() {
$nfdName = 'ümlaut';
$nfcName = 'ümlaut';
// call in succession due to cache
$this->assertEquals('/' . $nfcName, \OC\Files\Filesystem::normalizePath($nfdName, true, false, false));
$this->assertEquals('/' . $nfdName, \OC\Files\Filesystem::normalizePath($nfdName, true, false, true));
}
public function isValidPathData() {
return [
['/', true],
['/path', true],
['/foo/bar', true],
['/foo//bar/', true],
['/foo////bar', true],
['/foo//\///bar', true],
['/foo/bar/.', true],
['/foo/bar/./', true],
['/foo/bar/./.', true],
['/foo/bar/././', true],
['/foo/bar/././..bar', true],
['/foo/bar/././..bar/a', true],
['/foo/bar/././..', false],
['/foo/bar/././../', false],
['/foo/bar/.././', false],
['/foo/bar/../../', false],
['/foo/bar/../..\\', false],
['..', false],
['../', false],
['../foo/bar', false],
['..\foo/bar', false],
];
}
/**
* @dataProvider isValidPathData
*/
public function testIsValidPath($path, $expected) {
$this->assertSame($expected, \OC\Files\Filesystem::isValidPath($path));
}
2015-02-06 17:03:29 +03:00
public function isFileBlacklistedData() {
return [
['/etc/foo/bar/foo.txt', false],
['\etc\foo/bar\foo.txt', false],
['.htaccess', true],
['.htaccess/', true],
['.htaccess\\', true],
['/etc/foo\bar/.htaccess\\', true],
['/etc/foo\bar/.htaccess/', true],
['/etc/foo\bar/.htaccess/foo', false],
['//foo//bar/\.htaccess/', true],
['\foo\bar\.HTAccess', true],
];
2015-02-06 17:03:29 +03:00
}
/**
* @dataProvider isFileBlacklistedData
*/
public function testIsFileBlacklisted($path, $expected) {
$this->assertSame($expected, \OC\Files\Filesystem::isFileBlacklisted($path));
}
public function testNormalizePathUTF8() {
if (!class_exists('Patchwork\PHP\Shim\Normalizer')) {
$this->markTestSkipped('UTF8 normalizer Patchwork was not found');
}
$this->assertEquals("/foo/bar\xC3\xBC", \OC\Files\Filesystem::normalizePath("/foo/baru\xCC\x88"));
$this->assertEquals("/foo/bar\xC3\xBC", \OC\Files\Filesystem::normalizePath("\\foo\\baru\xCC\x88"));
}
2012-10-26 20:07:01 +04:00
public function testHooks() {
if (\OC\Files\Filesystem::getView()) {
2012-10-26 20:07:01 +04:00
$user = \OC_User::getUser();
} else {
2015-04-09 15:03:30 +03:00
$user = self::TEST_FILESYSTEM_USER1;
2015-09-22 01:56:36 +03:00
$backend = new \Test\Util\User\Dummy();
2015-04-09 15:03:30 +03:00
\OC_User::useBackend($backend);
$backend->createUser($user, $user);
$userObj = \OC::$server->getUserManager()->get($user);
\OC::$server->getUserSession()->setUser($userObj);
\OC\Files\Filesystem::init($user, '/' . $user . '/files');
2012-10-26 20:07:01 +04:00
}
\OC_Hook::clear('OC_Filesystem');
\OC_Hook::connect('OC_Filesystem', 'post_write', $this, 'dummyHook');
\OC\Files\Filesystem::mount('OC\Files\Storage\Temporary', [], '/');
2012-10-26 20:07:01 +04:00
$rootView = new \OC\Files\View('');
$rootView->mkdir('/' . $user);
$rootView->mkdir('/' . $user . '/files');
2012-10-26 20:07:01 +04:00
// \OC\Files\Filesystem::file_put_contents('/foo', 'foo');
2012-10-26 20:07:01 +04:00
\OC\Files\Filesystem::mkdir('/bar');
// \OC\Files\Filesystem::file_put_contents('/bar//foo', 'foo');
2012-10-26 20:07:01 +04:00
2015-12-18 13:25:33 +03:00
$tmpFile = \OC::$server->getTempManager()->getTemporaryFile();
2012-10-26 20:07:01 +04:00
file_put_contents($tmpFile, 'foo');
$fh = fopen($tmpFile, 'r');
// \OC\Files\Filesystem::file_put_contents('/bar//foo', $fh);
2012-10-26 20:07:01 +04:00
}
/**
* Tests that an exception is thrown when passed user does not exist.
*
*/
public function testLocalMountWhenUserDoesNotExist() {
$this->expectException(\OC\User\NoUserException::class);
$userId = $this->getUniqueID('user_');
\OC\Files\Filesystem::initMountPoints($userId);
}
public function testNullUserThrows() {
$this->expectException(\OC\User\NoUserException::class);
\OC\Files\Filesystem::initMountPoints(null);
}
public function testNullUserThrowsTwice() {
$thrown = 0;
try {
\OC\Files\Filesystem::initMountPoints(null);
} catch (NoUserException $e) {
$thrown++;
}
try {
\OC\Files\Filesystem::initMountPoints(null);
} catch (NoUserException $e) {
$thrown++;
}
$this->assertEquals(2, $thrown);
}
/**
* Tests that an exception is thrown when passed user does not exist.
*/
public function testLocalMountWhenUserDoesNotExistTwice() {
$thrown = 0;
$userId = $this->getUniqueID('user_');
try {
\OC\Files\Filesystem::initMountPoints($userId);
} catch (NoUserException $e) {
$thrown++;
}
try {
\OC\Files\Filesystem::initMountPoints($userId);
} catch (NoUserException $e) {
$thrown++;
}
$this->assertEquals(2, $thrown);
}
/**
* Tests that the home storage is used for the user's mount point
*/
public function testHomeMount() {
$userId = $this->getUniqueID('user_');
\OC::$server->getUserManager()->createUser($userId, $userId);
\OC\Files\Filesystem::initMountPoints($userId);
$homeMount = \OC\Files\Filesystem::getStorage('/' . $userId . '/');
2015-10-01 14:23:30 +03:00
$this->assertTrue($homeMount->instanceOfStorage('\OCP\Files\IHomeStorage'));
if ($homeMount->instanceOfStorage('\OC\Files\ObjectStore\HomeObjectStoreStorage')) {
2015-10-01 14:23:30 +03:00
$this->assertEquals('object::user:' . $userId, $homeMount->getId());
} elseif ($homeMount->instanceOfStorage('\OC\Files\Storage\Home')) {
2015-10-01 14:23:30 +03:00
$this->assertEquals('home::' . $userId, $homeMount->getId());
}
$user = \OC::$server->getUserManager()->get($userId);
if ($user !== null) {
$user->delete();
}
}
2012-10-26 20:07:01 +04:00
public function dummyHook($arguments) {
$path = $arguments['path'];
$this->assertEquals($path, \OC\Files\Filesystem::normalizePath($path)); //the path passed to the hook should already be normalized
}
/**
* Test that the default cache dir is part of the user's home
*/
public function testMountDefaultCacheDir() {
$userId = $this->getUniqueID('user_');
2015-12-03 15:48:19 +03:00
$config = \OC::$server->getConfig();
$oldCachePath = $config->getSystemValue('cache_path', '');
// no cache path configured
2015-12-03 15:48:19 +03:00
$config->setSystemValue('cache_path', '');
\OC::$server->getUserManager()->createUser($userId, $userId);
\OC\Files\Filesystem::initMountPoints($userId);
$this->assertEquals(
'/' . $userId . '/',
\OC\Files\Filesystem::getMountPoint('/' . $userId . '/cache')
);
list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath('/' . $userId . '/cache');
2015-10-01 14:23:30 +03:00
$this->assertTrue($storage->instanceOfStorage('\OCP\Files\IHomeStorage'));
$this->assertEquals('cache', $internalPath);
$user = \OC::$server->getUserManager()->get($userId);
if ($user !== null) {
$user->delete();
}
2015-12-03 15:48:19 +03:00
$config->setSystemValue('cache_path', $oldCachePath);
}
/**
* Test that an external cache is mounted into
* the user's home
*/
public function testMountExternalCacheDir() {
$userId = $this->getUniqueID('user_');
$config = \OC::$server->getConfig();
$oldCachePath = $config->getSystemValue('cache_path', '');
// set cache path to temp dir
2015-12-18 13:19:53 +03:00
$cachePath = \OC::$server->getTempManager()->getTemporaryFolder() . '/extcache';
$config->setSystemValue('cache_path', $cachePath);
\OC::$server->getUserManager()->createUser($userId, $userId);
\OC\Files\Filesystem::initMountPoints($userId);
$this->assertEquals(
'/' . $userId . '/cache/',
\OC\Files\Filesystem::getMountPoint('/' . $userId . '/cache')
);
list($storage, $internalPath) = \OC\Files\Filesystem::resolvePath('/' . $userId . '/cache');
$this->assertTrue($storage->instanceOfStorage('\OC\Files\Storage\Local'));
$this->assertEquals('', $internalPath);
$user = \OC::$server->getUserManager()->get($userId);
if ($user !== null) {
$user->delete();
}
$config->setSystemValue('cache_path', $oldCachePath);
}
public function testRegisterMountProviderAfterSetup() {
\OC\Files\Filesystem::initMountPoints(self::TEST_FILESYSTEM_USER2);
$this->assertEquals('/', \OC\Files\Filesystem::getMountPoint('/foo/bar'));
$mount = new MountPoint(new Temporary([]), '/foo/bar');
$mountProvider = new DummyMountProvider([self::TEST_FILESYSTEM_USER2 => [$mount]]);
\OC::$server->getMountProviderCollection()->registerProvider($mountProvider);
$this->assertEquals('/foo/bar/', \OC\Files\Filesystem::getMountPoint('/foo/bar'));
}
2012-10-26 20:07:01 +04:00
}