-
Notifications
You must be signed in to change notification settings - Fork 2.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
COPY does not delete the destination and by that allows to keep versi…
…ons - related to #18307 but needs to be addressed for MOVE
- Loading branch information
1 parent
f2dfbfb
commit 3dd9c11
Showing
8 changed files
with
284 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,95 @@ | ||
<?php | ||
/** | ||
* @author Thomas Müller <thomas.mueller@tmit.eu> | ||
* | ||
* @copyright Copyright (c) 2017, ownCloud GmbH | ||
* @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 OCA\DAV\DAV; | ||
|
||
use OCA\DAV\Connector\Sabre\File; | ||
use OCA\DAV\Files\ICopySource; | ||
use Sabre\DAV\IFile; | ||
use Sabre\DAV\Server; | ||
use Sabre\DAV\ServerPlugin; | ||
use Sabre\HTTP\RequestInterface; | ||
use Sabre\HTTP\ResponseInterface; | ||
|
||
/** | ||
* Class CopyPlugin - adds own implementation of the COPY method. | ||
* This is necessary because we don't want the target to be deleted before the move. | ||
* | ||
* Deleting the target will kill the versions which is the wrong behavior. | ||
* | ||
* @package OCA\DAV\DAV | ||
*/ | ||
class CopyPlugin extends ServerPlugin { | ||
|
||
/** @var Server */ | ||
private $server; | ||
|
||
/** | ||
* @param Server $server | ||
*/ | ||
function initialize(Server $server) { | ||
$this->server = $server; | ||
$server->on('method:COPY', [$this, 'httpCopy'], 90); | ||
} | ||
|
||
/** | ||
* WebDAV HTTP COPY method | ||
* | ||
* This method copies one uri to a different uri, and works much like the MOVE request | ||
* A lot of the actual request processing is done in getCopyMoveInfo | ||
* | ||
* @param RequestInterface $request | ||
* @param ResponseInterface $response | ||
* @return bool | ||
*/ | ||
function httpCopy(RequestInterface $request, ResponseInterface $response) { | ||
|
||
$path = $request->getPath(); | ||
|
||
$copyInfo = $this->server->getCopyAndMoveInfo($request); | ||
$sourceNode = $this->server->tree->getNodeForPath($path); | ||
$destinationNode = $copyInfo['destinationNode']; | ||
if (!$copyInfo['destinationExists'] || !$destinationNode instanceof File || !$sourceNode instanceof IFile) { | ||
return true; | ||
} | ||
|
||
if (!$this->server->emit('beforeBind', [$copyInfo['destination']])) return false; | ||
|
||
$copySuccess = false; | ||
if ($sourceNode instanceof ICopySource) { | ||
$copySuccess = $sourceNode->copy($destinationNode->getFileInfo()->getPath()); | ||
} | ||
if (!$copySuccess) { | ||
$destinationNode->put($sourceNode->get()); | ||
} | ||
|
||
$this->server->emit('afterBind', [$copyInfo['destination']]); | ||
|
||
$response->setHeader('Content-Length', '0'); | ||
$response->setStatus(204); | ||
|
||
// Sending back false will interrupt the event chain and tell the server | ||
// we've handled this method. | ||
return false; | ||
} | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
<?php | ||
/** | ||
* @author Thomas Müller <thomas.mueller@tmit.eu> | ||
* | ||
* @copyright Copyright (c) 2017, ownCloud GmbH | ||
* @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 OCA\DAV\Files; | ||
|
||
|
||
/** | ||
* Interface ICopySource | ||
* This interface allows special handling of copy operations based on the copy source. | ||
* This gives the developer the freedom to implement a more efficient copy operation. | ||
* | ||
* @package OCA\DAV\Files | ||
*/ | ||
interface ICopySource { | ||
|
||
/** | ||
* Copies the source to the given destination. | ||
* If the operation was not successful false is returned. | ||
* | ||
* @param string $destinationPath | ||
* @return boolean | ||
*/ | ||
public function copy($destinationPath); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,120 @@ | ||
<?php | ||
/** | ||
* @author Thomas Müller <thomas.mueller@tmit.eu> | ||
* | ||
* @copyright Copyright (c) 2017, ownCloud GmbH | ||
* @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 OCA\DAV\Tests\unit\DAV; | ||
|
||
|
||
use OCA\DAV\Connector\Sabre\Directory; | ||
use OCA\DAV\Connector\Sabre\File; | ||
use OCA\DAV\DAV\CopyPlugin; | ||
use Sabre\DAV\ICollection; | ||
use Sabre\DAV\IFile; | ||
use Sabre\DAV\Server; | ||
use Sabre\DAV\Tree; | ||
use Sabre\HTTP\RequestInterface; | ||
use Sabre\HTTP\ResponseInterface; | ||
use Test\TestCase; | ||
|
||
class CopyPluginTest extends TestCase { | ||
|
||
/** @var Server | \PHPUnit_Framework_MockObject_MockObject */ | ||
private $server; | ||
/** @var CopyPlugin */ | ||
private $plugin; | ||
/** @var Tree | \PHPUnit_Framework_MockObject_MockObject */ | ||
private $tree; | ||
/** @var RequestInterface | \PHPUnit_Framework_MockObject_MockObject */ | ||
private $request; | ||
/** @var ResponseInterface | \PHPUnit_Framework_MockObject_MockObject */ | ||
private $response; | ||
|
||
public function setUp() { | ||
parent::setUp(); | ||
$this->plugin = new CopyPlugin(); | ||
|
||
$this->server = $this->createMock(Server::class); | ||
$this->tree = $this->createMock(Tree::class); | ||
$this->server->tree = $this->tree; | ||
/** @var RequestInterface | \PHPUnit_Framework_MockObject_MockObject $request */ | ||
$this->request = $this->createMock(RequestInterface::class); | ||
/** @var ResponseInterface | \PHPUnit_Framework_MockObject_MockObject $response */ | ||
$this->response = $this->createMock( ResponseInterface::class); | ||
|
||
$this->plugin->initialize($this->server); | ||
} | ||
|
||
/** | ||
* @dataProvider providesSourceAndDestinations | ||
* @param bool $destinationExists | ||
* @param $destinationNode | ||
* @param $sourceNode | ||
*/ | ||
public function testCopyPluginReturnTrue($destinationExists, $destinationNode, $sourceNode) { | ||
|
||
$this->tree->expects($this->once())->method('getNodeForPath')->willReturn($sourceNode); | ||
$this->server->expects($this->once())->method('getCopyAndMoveInfo')->willReturn([ | ||
'destinationExists' => $destinationExists, | ||
'destinationNode' => $destinationNode | ||
]); | ||
|
||
$returnValue = $this->plugin->httpCopy($this->request, $this->response); | ||
$this->assertTrue($returnValue); | ||
} | ||
|
||
public function providesSourceAndDestinations() { | ||
return [ | ||
'destination does not exist' => [false, null, null], | ||
'destination is not a File' => [true, $this->createMock(Directory::class), $this->createMock(IFile::class)], | ||
'source is not a IFile' => [true, $this->createMock(File::class), $this->createMock(ICollection::class)], | ||
]; | ||
} | ||
|
||
public function testCopyPluginReturnFalse() { | ||
|
||
$destinationNode = $this->createMock(File::class); | ||
$sourceNode = $this->createMock(IFile::class); | ||
|
||
$this->tree->expects($this->once())->method('getNodeForPath')->willReturn($sourceNode); | ||
$this->server->expects($this->once())->method('getCopyAndMoveInfo')->willReturn([ | ||
'destinationExists' => true, | ||
'destinationNode' => $destinationNode, | ||
'destination' => 'destination.txt' | ||
]); | ||
|
||
// make sure the plugin properly emits beforeBind and afterBind | ||
$this->server->expects($this->exactly(2))->method('emit')->withConsecutive( | ||
['beforeBind', ['destination.txt']], ['afterBind', ['destination.txt']])->willReturn(true); | ||
|
||
// make sure the file content is actually copied over | ||
$sourceNode->expects($this->once())->method('get')->willReturn('123456'); | ||
$destinationNode->expects($this->once())->method('put')->with('123456'); | ||
|
||
// make sure http status and content length are properly set | ||
$this->response->expects($this->once())->method('setHeader')->with('Content-Length', '0'); | ||
$this->response->expects($this->once())->method('setStatus')->with(204); | ||
|
||
$returnValue = $this->plugin->httpCopy($this->request, $this->response); | ||
$this->assertFalse($returnValue); | ||
} | ||
|
||
|
||
} |