* This file is licensed under the Affero General Public License version 3 or * later. * See the COPYING-README file. */ namespace Test\Connector\Sabre; use Test\HookHelper; use OC\Files\Filesystem; use OCP\Lock\ILockingProvider; class File extends \Test\TestCase { /** * @var string */ private $user; public function setUp() { parent::setUp(); \OC_Hook::clear(); $this->user = $this->getUniqueID('user_'); $userManager = \OC::$server->getUserManager(); $userManager->createUser($this->user, 'pass'); $this->loginAsUser($this->user); } public function tearDown() { $userManager = \OC::$server->getUserManager(); $userManager->get($this->user)->delete(); unset($_SERVER['HTTP_OC_CHUNKED']); parent::tearDown(); } private function getStream($string) { $stream = fopen('php://temp', 'r+'); fwrite($stream, $string); fseek($stream, 0); return $stream; } public function fopenFailuresProvider() { return [ [ // return false null, '\Sabre\Dav\Exception', false ], [ new \OCP\Files\NotPermittedException(), 'Sabre\DAV\Exception\Forbidden' ], [ new \OCP\Files\EntityTooLargeException(), 'OCA\DAV\Connector\Sabre\Exception\EntityTooLarge' ], [ new \OCP\Files\InvalidContentException(), 'OCA\DAV\Connector\Sabre\Exception\UnsupportedMediaType' ], [ new \OCP\Files\InvalidPathException(), 'Sabre\DAV\Exception\Forbidden' ], [ new \OCP\Files\LockNotAcquiredException('/test.txt', 1), 'OCA\DAV\Connector\Sabre\Exception\FileLocked' ], [ new \OCP\Lock\LockedException('/test.txt'), 'OCA\DAV\Connector\Sabre\Exception\FileLocked' ], [ new \OCP\Encryption\Exceptions\GenericEncryptionException(), 'Sabre\DAV\Exception\ServiceUnavailable' ], [ new \OCP\Files\StorageNotAvailableException(), 'Sabre\DAV\Exception\ServiceUnavailable' ], [ new \Sabre\DAV\Exception('Generic sabre exception'), 'Sabre\DAV\Exception', false ], [ new \Exception('Generic exception'), 'Sabre\DAV\Exception' ], ]; } /** * @dataProvider fopenFailuresProvider */ public function testSimplePutFails($thrownException, $expectedException, $checkPreviousClass = true) { // setup $storage = $this->getMock( '\OC\Files\Storage\Local', ['fopen'], [['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]] ); \OC\Files\Filesystem::mount($storage, [], $this->user . '/'); $view = $this->getMock('\OC\Files\View', array('getRelativePath', 'resolvePath'), array()); $view->expects($this->atLeastOnce()) ->method('resolvePath') ->will($this->returnCallback( function ($path) use ($storage) { return [$storage, $path]; } )); if ($thrownException !== null) { $storage->expects($this->once()) ->method('fopen') ->will($this->throwException($thrownException)); } else { $storage->expects($this->once()) ->method('fopen') ->will($this->returnValue(false)); } $view->expects($this->any()) ->method('getRelativePath') ->will($this->returnArgument(0)); $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $caughtException = null; try { $file->put('test data'); } catch (\Exception $e) { $caughtException = $e; } $this->assertInstanceOf($expectedException, $caughtException); if ($checkPreviousClass) { $this->assertInstanceOf(get_class($thrownException), $caughtException->getPrevious()); } $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * Test putting a file using chunking * * @dataProvider fopenFailuresProvider */ public function testChunkedPutFails($thrownException, $expectedException, $checkPreviousClass = false) { // setup $storage = $this->getMock( '\OC\Files\Storage\Local', ['fopen'], [['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]] ); \OC\Files\Filesystem::mount($storage, [], $this->user . '/'); $view = $this->getMock('\OC\Files\View', ['getRelativePath', 'resolvePath'], []); $view->expects($this->atLeastOnce()) ->method('resolvePath') ->will($this->returnCallback( function ($path) use ($storage) { return [$storage, $path]; } )); if ($thrownException !== null) { $storage->expects($this->once()) ->method('fopen') ->will($this->throwException($thrownException)); } else { $storage->expects($this->once()) ->method('fopen') ->will($this->returnValue(false)); } $view->expects($this->any()) ->method('getRelativePath') ->will($this->returnArgument(0)); $_SERVER['HTTP_OC_CHUNKED'] = true; $info = new \OC\Files\FileInfo('/test.txt-chunking-12345-2-0', null, null, [ 'permissions' => \OCP\Constants::PERMISSION_ALL ], null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // put first chunk $this->assertNull($file->put('test data one')); $info = new \OC\Files\FileInfo('/test.txt-chunking-12345-2-1', null, null, [ 'permissions' => \OCP\Constants::PERMISSION_ALL ], null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $caughtException = null; try { // last chunk $file->acquireLock(ILockingProvider::LOCK_SHARED); $file->put('test data two'); $file->releaseLock(ILockingProvider::LOCK_SHARED); } catch (\Exception $e) { $caughtException = $e; } $this->assertInstanceOf($expectedException, $caughtException); if ($checkPreviousClass) { $this->assertInstanceOf(get_class($thrownException), $caughtException->getPrevious()); } $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * Simulate putting a file to the given path. * * @param string $path path to put the file into * @param string $viewRoot root to use for the view * * @return result of the PUT operaiton which is usually the etag */ private function doPut($path, $viewRoot = null) { $view = \OC\Files\Filesystem::getView(); if (!is_null($viewRoot)) { $view = new \OC\Files\View($viewRoot); } else { $viewRoot = '/' . $this->user . '/files'; } $info = new \OC\Files\FileInfo( $viewRoot . '/' . ltrim($path, '/'), null, null, ['permissions' => \OCP\Constants::PERMISSION_ALL], null ); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // beforeMethod locks $view->lockFile($path, ILockingProvider::LOCK_SHARED); $result = $file->put($this->getStream('test data')); // afterMethod unlocks $view->unlockFile($path, ILockingProvider::LOCK_SHARED); return $result; } /** * Test putting a single file */ public function testPutSingleFile() { $this->assertNotEmpty($this->doPut('/foo.txt')); } /** * Test putting a file using chunking */ public function testChunkedPut() { $_SERVER['HTTP_OC_CHUNKED'] = true; $this->assertNull($this->doPut('/test.txt-chunking-12345-2-0')); $this->assertNotEmpty($this->doPut('/test.txt-chunking-12345-2-1')); } /** * Test that putting a file triggers create hooks */ public function testPutSingleFileTriggersHooks() { HookHelper::setUpHooks(); $this->assertNotEmpty($this->doPut('/foo.txt')); $this->assertCount(4, HookHelper::$hookCalls); $this->assertHookCall( HookHelper::$hookCalls[0], Filesystem::signal_create, '/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[1], Filesystem::signal_write, '/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[2], Filesystem::signal_post_create, '/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[3], Filesystem::signal_post_write, '/foo.txt' ); } /** * Test that putting a file triggers update hooks */ public function testPutOverwriteFileTriggersHooks() { $view = \OC\Files\Filesystem::getView(); $view->file_put_contents('/foo.txt', 'some content that will be replaced'); HookHelper::setUpHooks(); $this->assertNotEmpty($this->doPut('/foo.txt')); $this->assertCount(4, HookHelper::$hookCalls); $this->assertHookCall( HookHelper::$hookCalls[0], Filesystem::signal_update, '/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[1], Filesystem::signal_write, '/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[2], Filesystem::signal_post_update, '/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[3], Filesystem::signal_post_write, '/foo.txt' ); } /** * Test that putting a file triggers hooks with the correct path * if the passed view was chrooted (can happen with public webdav * where the root is the share root) */ public function testPutSingleFileTriggersHooksDifferentRoot() { $view = \OC\Files\Filesystem::getView(); $view->mkdir('noderoot'); HookHelper::setUpHooks(); // happens with public webdav where the view root is the share root $this->assertNotEmpty($this->doPut('/foo.txt', '/' . $this->user . '/files/noderoot')); $this->assertCount(4, HookHelper::$hookCalls); $this->assertHookCall( HookHelper::$hookCalls[0], Filesystem::signal_create, '/noderoot/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[1], Filesystem::signal_write, '/noderoot/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[2], Filesystem::signal_post_create, '/noderoot/foo.txt' ); $this->assertHookCall( HookHelper::$hookCalls[3], Filesystem::signal_post_write, '/noderoot/foo.txt' ); } public static function cancellingHook($params) { self::$hookCalls[] = array( 'signal' => Filesystem::signal_post_create, 'params' => $params ); } /** * Test put file with cancelled hook */ public function testPutSingleFileCancelPreHook() { \OCP\Util::connectHook( Filesystem::CLASSNAME, Filesystem::signal_create, '\Test\HookHelper', 'cancellingCallback' ); // action $thrown = false; try { $this->doPut('/foo.txt'); } catch (\Sabre\DAV\Exception $e) { $thrown = true; } $this->assertTrue($thrown); $this->assertEmpty($this->listPartFiles(), 'No stray part files'); } /** * Test exception when the uploaded size did not match */ public function testSimplePutFailsSizeCheck() { // setup $view = $this->getMock('\OC\Files\View', array('rename', 'getRelativePath', 'filesize')); $view->expects($this->any()) ->method('rename') ->withAnyParameters() ->will($this->returnValue(false)); $view->expects($this->any()) ->method('getRelativePath') ->will($this->returnArgument(0)); $view->expects($this->any()) ->method('filesize') ->will($this->returnValue(123456)); $_SERVER['CONTENT_LENGTH'] = 123456; $_SERVER['REQUEST_METHOD'] = 'PUT'; $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $thrown = false; try { // beforeMethod locks $view->lockFile('/test.txt', ILockingProvider::LOCK_SHARED); $file->put($this->getStream('test data')); // afterMethod unlocks $view->unlockFile('/test.txt', ILockingProvider::LOCK_SHARED); } catch (\Sabre\DAV\Exception\BadRequest $e) { $thrown = true; } $this->assertTrue($thrown); $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * Test exception during final rename in simple upload mode */ public function testSimplePutFailsMoveFromStorage() { $view = new \OC\Files\View('/' . $this->user . '/files'); // simulate situation where the target file is locked $view->lockFile('/test.txt', ILockingProvider::LOCK_EXCLUSIVE); $info = new \OC\Files\FileInfo('/' . $this->user . '/files/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $thrown = false; try { // beforeMethod locks $view->lockFile($info->getPath(), ILockingProvider::LOCK_SHARED); $file->put($this->getStream('test data')); // afterMethod unlocks $view->unlockFile($info->getPath(), ILockingProvider::LOCK_SHARED); } catch (\OCA\DAV\Connector\Sabre\Exception\FileLocked $e) { $thrown = true; } $this->assertTrue($thrown); $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * Test exception during final rename in chunk upload mode */ public function testChunkedPutFailsFinalRename() { $view = new \OC\Files\View('/' . $this->user . '/files'); // simulate situation where the target file is locked $view->lockFile('/test.txt', ILockingProvider::LOCK_EXCLUSIVE); $_SERVER['HTTP_OC_CHUNKED'] = true; $info = new \OC\Files\FileInfo('/' . $this->user . '/files/test.txt-chunking-12345-2-0', null, null, [ 'permissions' => \OCP\Constants::PERMISSION_ALL ], null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); $this->assertNull($file->put('test data one')); $info = new \OC\Files\FileInfo('/' . $this->user . '/files/test.txt-chunking-12345-2-1', null, null, [ 'permissions' => \OCP\Constants::PERMISSION_ALL ], null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $thrown = false; try { $file->put($this->getStream('test data')); } catch (\OCA\DAV\Connector\Sabre\Exception\FileLocked $e) { $thrown = true; } $this->assertTrue($thrown); $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * Test put file with invalid chars */ public function testSimplePutInvalidChars() { // setup $view = $this->getMock('\OC\Files\View', array('getRelativePath')); $view->expects($this->any()) ->method('getRelativePath') ->will($this->returnArgument(0)); $info = new \OC\Files\FileInfo('/*', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $thrown = false; try { // beforeMethod locks $view->lockFile($info->getPath(), ILockingProvider::LOCK_SHARED); $file->put($this->getStream('test data')); // afterMethod unlocks $view->unlockFile($info->getPath(), ILockingProvider::LOCK_SHARED); } catch (\OCA\DAV\Connector\Sabre\Exception\InvalidPath $e) { $thrown = true; } $this->assertTrue($thrown); $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * Test setting name with setName() with invalid chars * * @expectedException \OCA\DAV\Connector\Sabre\Exception\InvalidPath */ public function testSetNameInvalidChars() { // setup $view = $this->getMock('\OC\Files\View', array('getRelativePath')); $view->expects($this->any()) ->method('getRelativePath') ->will($this->returnArgument(0)); $info = new \OC\Files\FileInfo('/*', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); $file->setName('/super*star.txt'); } /** */ public function testUploadAbort() { // setup $view = $this->getMock('\OC\Files\View', array('rename', 'getRelativePath', 'filesize')); $view->expects($this->any()) ->method('rename') ->withAnyParameters() ->will($this->returnValue(false)); $view->expects($this->any()) ->method('getRelativePath') ->will($this->returnArgument(0)); $view->expects($this->any()) ->method('filesize') ->will($this->returnValue(123456)); $_SERVER['CONTENT_LENGTH'] = 12345; $_SERVER['REQUEST_METHOD'] = 'PUT'; $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $thrown = false; try { // beforeMethod locks $view->lockFile($info->getPath(), ILockingProvider::LOCK_SHARED); $file->put($this->getStream('test data')); // afterMethod unlocks $view->unlockFile($info->getPath(), ILockingProvider::LOCK_SHARED); } catch (\Sabre\DAV\Exception\BadRequest $e) { $thrown = true; } $this->assertTrue($thrown); $this->assertEmpty($this->listPartFiles($view, ''), 'No stray part files'); } /** * */ public function testDeleteWhenAllowed() { // setup $view = $this->getMock('\OC\Files\View', array()); $view->expects($this->once()) ->method('unlink') ->will($this->returnValue(true)); $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $file->delete(); } /** * @expectedException \Sabre\DAV\Exception\Forbidden */ public function testDeleteThrowsWhenDeletionNotAllowed() { // setup $view = $this->getMock('\OC\Files\View', array()); $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => 0 ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $file->delete(); } /** * @expectedException \Sabre\DAV\Exception\Forbidden */ public function testDeleteThrowsWhenDeletionFailed() { // setup $view = $this->getMock('\OC\Files\View', array()); // but fails $view->expects($this->once()) ->method('unlink') ->will($this->returnValue(false)); $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); // action $file->delete(); } /** * Asserts hook call * * @param array $callData hook call data to check * @param string $signal signal name * @param string $hookPath hook path */ protected function assertHookCall($callData, $signal, $hookPath) { $this->assertEquals($signal, $callData['signal']); $params = $callData['params']; $this->assertEquals( $hookPath, $params[Filesystem::signal_param_path] ); } /** * Test whether locks are set before and after the operation */ public function testPutLocking() { $view = new \OC\Files\View('/' . $this->user . '/files/'); $path = 'test-locking.txt'; $info = new \OC\Files\FileInfo( '/' . $this->user . '/files/' . $path, null, null, ['permissions' => \OCP\Constants::PERMISSION_ALL], null ); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); $this->assertFalse( $this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_SHARED), 'File unlocked before put' ); $this->assertFalse( $this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE), 'File unlocked before put' ); $wasLockedPre = false; $wasLockedPost = false; $eventHandler = $this->getMockBuilder('\stdclass') ->setMethods(['writeCallback', 'postWriteCallback']) ->getMock(); // both pre and post hooks might need access to the file, // so only shared lock is acceptable $eventHandler->expects($this->once()) ->method('writeCallback') ->will($this->returnCallback( function () use ($view, $path, &$wasLockedPre) { $wasLockedPre = $this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_SHARED); $wasLockedPre = $wasLockedPre && !$this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE); } )); $eventHandler->expects($this->once()) ->method('postWriteCallback') ->will($this->returnCallback( function () use ($view, $path, &$wasLockedPost) { $wasLockedPost = $this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_SHARED); $wasLockedPost = $wasLockedPost && !$this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE); } )); \OCP\Util::connectHook( Filesystem::CLASSNAME, Filesystem::signal_write, $eventHandler, 'writeCallback' ); \OCP\Util::connectHook( Filesystem::CLASSNAME, Filesystem::signal_post_write, $eventHandler, 'postWriteCallback' ); // beforeMethod locks $view->lockFile($path, ILockingProvider::LOCK_SHARED); $this->assertNotEmpty($file->put($this->getStream('test data'))); // afterMethod unlocks $view->unlockFile($path, ILockingProvider::LOCK_SHARED); $this->assertTrue($wasLockedPre, 'File was locked during pre-hooks'); $this->assertTrue($wasLockedPost, 'File was locked during post-hooks'); $this->assertFalse( $this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_SHARED), 'File unlocked after put' ); $this->assertFalse( $this->isFileLocked($view, $path, \OCP\Lock\ILockingProvider::LOCK_EXCLUSIVE), 'File unlocked after put' ); } /** * Returns part files in the given path * * @param \OC\Files\View view which root is the current user's "files" folder * @param string $path path for which to list part files * * @return array list of part files */ private function listPartFiles(\OC\Files\View $userView = null, $path = '') { if ($userView === null) { $userView = \OC\Files\Filesystem::getView(); } $files = []; list($storage, $internalPath) = $userView->resolvePath($path); $realPath = $storage->getSourcePath($internalPath); $dh = opendir($realPath); while (($file = readdir($dh)) !== false) { if (substr($file, strlen($file) - 5, 5) === '.part') { $files[] = $file; } } closedir($dh); return $files; } /** * @expectedException \Sabre\DAV\Exception\ServiceUnavailable */ public function testGetFopenFails() { $view = $this->getMock('\OC\Files\View', ['fopen'], array()); $view->expects($this->atLeastOnce()) ->method('fopen') ->will($this->returnValue(false)); $info = new \OC\Files\FileInfo('/test.txt', null, null, array( 'permissions' => \OCP\Constants::PERMISSION_ALL ), null); $file = new \OCA\DAV\Connector\Sabre\File($view, $info); $file->get(); } }