Skip to content

Commit

Permalink
Merge pull request #7533 from nextcloud/oc-28545-handle-oc-total-leng…
Browse files Browse the repository at this point in the history
…th-in-new-chunking

[oc] Handle OC-Total-Length in new chunking
  • Loading branch information
MorrisJobke authored Jan 3, 2018
2 parents ee0653d + ec8bf53 commit 876238c
Show file tree
Hide file tree
Showing 14 changed files with 351 additions and 121 deletions.
4 changes: 3 additions & 1 deletion apps/dav/bin/chunkperf.php
Original file line number Diff line number Diff line change
Expand Up @@ -73,5 +73,7 @@ function request($client, $method, $uploadUrl, $data = null, $headers = []) {
$destination = pathinfo($file, PATHINFO_BASENAME);
//echo "Moving $uploadUrl/.file to it's final destination $baseUri/files/$userName/$destination" . PHP_EOL;
request($client, 'MOVE', "$uploadUrl/.file", null, [
'Destination' => "$baseUri/files/$userName/$destination"
'Destination' => "$baseUri/files/$userName/$destination",
'OC-Total-Length' => filesize($file),
'X-OC-MTime' => filemtime($file)
]);
1 change: 1 addition & 0 deletions apps/dav/composer/composer/autoload_classmap.php
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,7 @@
'OCA\\DAV\\SystemTag\\SystemTagsObjectTypeCollection' => $baseDir . '/../lib/SystemTag/SystemTagsObjectTypeCollection.php',
'OCA\\DAV\\SystemTag\\SystemTagsRelationsCollection' => $baseDir . '/../lib/SystemTag/SystemTagsRelationsCollection.php',
'OCA\\DAV\\Upload\\AssemblyStream' => $baseDir . '/../lib/Upload/AssemblyStream.php',
'OCA\\DAV\\Upload\\ChunkingPlugin' => $baseDir . '/../lib/Upload/ChunkingPlugin.php',
'OCA\\DAV\\Upload\\FutureFile' => $baseDir . '/../lib/Upload/FutureFile.php',
'OCA\\DAV\\Upload\\RootCollection' => $baseDir . '/../lib/Upload/RootCollection.php',
'OCA\\DAV\\Upload\\UploadFolder' => $baseDir . '/../lib/Upload/UploadFolder.php',
Expand Down
1 change: 1 addition & 0 deletions apps/dav/composer/composer/autoload_static.php
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\SystemTag\\SystemTagsObjectTypeCollection' => __DIR__ . '/..' . '/../lib/SystemTag/SystemTagsObjectTypeCollection.php',
'OCA\\DAV\\SystemTag\\SystemTagsRelationsCollection' => __DIR__ . '/..' . '/../lib/SystemTag/SystemTagsRelationsCollection.php',
'OCA\\DAV\\Upload\\AssemblyStream' => __DIR__ . '/..' . '/../lib/Upload/AssemblyStream.php',
'OCA\\DAV\\Upload\\ChunkingPlugin' => __DIR__ . '/..' . '/../lib/Upload/ChunkingPlugin.php',
'OCA\\DAV\\Upload\\FutureFile' => __DIR__ . '/..' . '/../lib/Upload/FutureFile.php',
'OCA\\DAV\\Upload\\RootCollection' => __DIR__ . '/..' . '/../lib/Upload/RootCollection.php',
'OCA\\DAV\\Upload\\UploadFolder' => __DIR__ . '/..' . '/../lib/Upload/UploadFolder.php',
Expand Down
12 changes: 0 additions & 12 deletions apps/dav/lib/Connector/Sabre/File.php
Original file line number Diff line number Diff line change
Expand Up @@ -589,18 +589,6 @@ private function convertToSabreException(\Exception $e) {
throw new \Sabre\DAV\Exception($e->getMessage(), 0, $e);
}

private function sanitizeMtime($mtimeFromRequest) {
// In PHP 5.X "is_numeric" returns true for strings in hexadecimal
// notation. This is no longer the case in PHP 7.X, so this check
// ensures that strings with hexadecimal notations fail too in PHP 5.X.
$isHexadecimal = is_string($mtimeFromRequest) && preg_match('/^\s*0[xX]/', $mtimeFromRequest);
if ($isHexadecimal || !is_numeric($mtimeFromRequest)) {
throw new \InvalidArgumentException('X-OC-MTime header must be an integer (unix timestamp).');
}

return intval($mtimeFromRequest);
}

/**
* Get the checksum for this file
*
Expand Down
54 changes: 4 additions & 50 deletions apps/dav/lib/Connector/Sabre/FilesPlugin.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@

namespace OCA\DAV\Connector\Sabre;

use OC\Files\View;
use OC\AppFramework\Http\Request;
use OCP\Files\ForbiddenException;
use OCP\IPreview;
use Sabre\DAV\Exception\Forbidden;
Expand All @@ -47,7 +47,6 @@
use OCP\Files\StorageNotAvailableException;
use OCP\IConfig;
use OCP\IRequest;
use OCA\DAV\Upload\FutureFile;

class FilesPlugin extends ServerPlugin {

Expand Down Expand Up @@ -90,11 +89,6 @@ class FilesPlugin extends ServerPlugin {
*/
private $isPublic;

/**
* @var View
*/
private $fileView;

/**
* @var bool
*/
Expand Down Expand Up @@ -183,7 +177,6 @@ public function initialize(\Sabre\DAV\Server $server) {
}
});
$this->server->on('beforeMove', [$this, 'checkMove']);
$this->server->on('beforeMove', [$this, 'beforeMoveFutureFile']);
}

/**
Expand Down Expand Up @@ -258,9 +251,9 @@ function httpGet(RequestInterface $request, ResponseInterface $response) {
$filename = $node->getName();
if ($this->request->isUserAgent(
[
\OC\AppFramework\Http\Request::USER_AGENT_IE,
\OC\AppFramework\Http\Request::USER_AGENT_ANDROID_MOBILE_CHROME,
\OC\AppFramework\Http\Request::USER_AGENT_FREEBOX,
Request::USER_AGENT_IE,
Request::USER_AGENT_ANDROID_MOBILE_CHROME,
Request::USER_AGENT_FREEBOX,
])) {
$response->addHeader('Content-Disposition', 'attachment; filename="' . rawurlencode($filename) . '"');
} else {
Expand Down Expand Up @@ -461,43 +454,4 @@ public function sendFileIdHeader($filePath, \Sabre\DAV\INode $node = null) {
}
}
}

/**
* Move handler for future file.
*
* This overrides the default move behavior to prevent Sabre
* to delete the target file before moving. Because deleting would
* lose the file id and metadata.
*
* @param string $path source path
* @param string $destination destination path
* @return bool|void false to stop handling, void to skip this handler
*/
public function beforeMoveFutureFile($path, $destination) {
$sourceNode = $this->tree->getNodeForPath($path);
if (!$sourceNode instanceof FutureFile) {
// skip handling as the source is not a chunked FutureFile
return;
}

if (!$this->tree->nodeExists($destination)) {
// skip and let the default handler do its work
return;
}

// do a move manually, skipping Sabre's default "delete" for existing nodes
$this->tree->move($path, $destination);

// trigger all default events (copied from CorePlugin::move)
$this->server->emit('afterMove', [$path, $destination]);
$this->server->emit('afterUnbind', [$path]);
$this->server->emit('afterBind', [$destination]);

$response = $this->server->httpResponse;
$response->setHeader('Content-Length', '0');
$response->setStatus(204);

return false;
}

}
14 changes: 14 additions & 0 deletions apps/dav/lib/Connector/Sabre/Node.php
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@ public function getLastModified() {
* Even if the modification time is set to a custom value the access time is set to now.
*/
public function touch($mtime) {
$mtime = $this->sanitizeMtime($mtime);
$this->fileView->touch($this->path, $mtime);
$this->refreshInfo();
}
Expand Down Expand Up @@ -358,4 +359,17 @@ public function changeLock($type) {
public function getFileInfo() {
return $this->info;
}

protected function sanitizeMtime($mtimeFromRequest) {
// In PHP 5.X "is_numeric" returns true for strings in hexadecimal
// notation. This is no longer the case in PHP 7.X, so this check
// ensures that strings with hexadecimal notations fail too in PHP 5.X.
$isHexadecimal = is_string($mtimeFromRequest) && preg_match('/^\s*0[xX]/', $mtimeFromRequest);
if ($isHexadecimal || !is_numeric($mtimeFromRequest)) {
throw new \InvalidArgumentException('X-OC-MTime header must be an integer (unix timestamp).');
}

return intval($mtimeFromRequest);
}

}
2 changes: 2 additions & 0 deletions apps/dav/lib/Server.php
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
use OCA\DAV\Connector\Sabre\QuotaPlugin;
use OCA\DAV\Files\BrowserErrorPagePlugin;
use OCA\DAV\SystemTag\SystemTagPlugin;
use OCA\DAV\Upload\ChunkingPlugin;
use OCP\IRequest;
use OCP\SabrePluginEvent;
use Sabre\CardDAV\VCFExportPlugin;
Expand Down Expand Up @@ -171,6 +172,7 @@ public function __construct(IRequest $request, $baseUri) {
));

$this->server->addPlugin(new CopyEtagHeaderPlugin());
$this->server->addPlugin(new ChunkingPlugin());

// allow setup of additional plugins
$dispatcher->dispatch('OCA\DAV\Connector\Sabre::addPlugin', $event);
Expand Down
106 changes: 106 additions & 0 deletions apps/dav/lib/Upload/ChunkingPlugin.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<?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\Upload;


use OCA\DAV\Connector\Sabre\File;
use Sabre\DAV\Exception\BadRequest;
use Sabre\DAV\Server;
use Sabre\DAV\ServerPlugin;

class ChunkingPlugin extends ServerPlugin {

/** @var Server */
private $server;
/** @var FutureFile */
private $sourceNode;

/**
* @inheritdoc
*/
function initialize(Server $server) {
$server->on('beforeMove', [$this, 'beforeMove']);
$this->server = $server;
}

/**
* @param string $sourcePath source path
* @param string $destination destination path
*/
function beforeMove($sourcePath, $destination) {
$this->sourceNode = $this->server->tree->getNodeForPath($sourcePath);
if (!$this->sourceNode instanceof FutureFile) {
// skip handling as the source is not a chunked FutureFile
return;
}

$this->verifySize();
return $this->performMove($sourcePath, $destination);
}

/**
* Move handler for future file.
*
* This overrides the default move behavior to prevent Sabre
* to delete the target file before moving. Because deleting would
* lose the file id and metadata.
*
* @param string $path source path
* @param string $destination destination path
* @return bool|void false to stop handling, void to skip this handler
*/
public function performMove($path, $destination) {
if (!$this->server->tree->nodeExists($destination)) {
// skip and let the default handler do its work
return;
}

// do a move manually, skipping Sabre's default "delete" for existing nodes
$this->server->tree->move($path, $destination);

// trigger all default events (copied from CorePlugin::move)
$this->server->emit('afterMove', [$path, $destination]);
$this->server->emit('afterUnbind', [$path]);
$this->server->emit('afterBind', [$destination]);

$response = $this->server->httpResponse;
$response->setHeader('Content-Length', '0');
$response->setStatus(204);

return false;
}

/**
* @throws BadRequest
*/
private function verifySize() {
$expectedSize = $this->server->httpRequest->getHeader('OC-Total-Length');
if ($expectedSize === null) {
return;
}
$actualSize = $this->sourceNode->getSize();
if ((int)$expectedSize !== $actualSize) {
throw new BadRequest("Chunks on server do not sum up to $expectedSize but to $actualSize bytes");
}
}
}
4 changes: 4 additions & 0 deletions apps/dav/tests/unit/Connector/Sabre/FileTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ public function tearDown() {
parent::tearDown();
}

/**
* @return \PHPUnit_Framework_MockObject_MockObject | Storage
*/
private function getMockStorage() {
$storage = $this->getMockBuilder(Storage::class)
->disableOriginalConstructor()
Expand Down Expand Up @@ -165,6 +168,7 @@ public function testSimplePutFails($thrownException, $expectedException, $checkP
->setConstructorArgs([['datadir' => \OC::$server->getTempManager()->getTemporaryFolder()]])
->getMock();
\OC\Files\Filesystem::mount($storage, [], $this->user . '/');
/** @var View | \PHPUnit_Framework_MockObject_MockObject $view */
$view = $this->getMockBuilder(View::class)
->setMethods(['getRelativePath', 'resolvePath'])
->getMock();
Expand Down
57 changes: 0 additions & 57 deletions apps/dav/tests/unit/Connector/Sabre/FilesPluginTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,6 @@
use Sabre\HTTP\RequestInterface;
use Sabre\HTTP\ResponseInterface;
use Test\TestCase;
use OCA\DAV\Upload\FutureFile;
use OCA\DAV\Connector\Sabre\Directory;
use OCP\Files\FileInfo;

/**
Expand Down Expand Up @@ -600,59 +598,4 @@ public function testHasPreview() {

$this->assertEquals("false", $propFind->get(self::HAS_PREVIEW_PROPERTYNAME));
}

public function testBeforeMoveFutureFileSkip() {
$node = $this->createMock(Directory::class);

$this->tree->expects($this->any())
->method('getNodeForPath')
->with('source')
->will($this->returnValue($node));
$this->server->httpResponse->expects($this->never())
->method('setStatus');

$this->assertNull($this->plugin->beforeMoveFutureFile('source', 'target'));
}

public function testBeforeMoveFutureFileSkipNonExisting() {
$sourceNode = $this->createMock(FutureFile::class);

$this->tree->expects($this->any())
->method('getNodeForPath')
->with('source')
->will($this->returnValue($sourceNode));
$this->tree->expects($this->any())
->method('nodeExists')
->with('target')
->will($this->returnValue(false));
$this->server->httpResponse->expects($this->never())
->method('setStatus');

$this->assertNull($this->plugin->beforeMoveFutureFile('source', 'target'));
}

public function testBeforeMoveFutureFileMoveIt() {
$sourceNode = $this->createMock(FutureFile::class);

$this->tree->expects($this->any())
->method('getNodeForPath')
->with('source')
->will($this->returnValue($sourceNode));
$this->tree->expects($this->any())
->method('nodeExists')
->with('target')
->will($this->returnValue(true));
$this->tree->expects($this->once())
->method('move')
->with('source', 'target');

$this->server->httpResponse->expects($this->once())
->method('setHeader')
->with('Content-Length', '0');
$this->server->httpResponse->expects($this->once())
->method('setStatus')
->with(204);

$this->assertFalse($this->plugin->beforeMoveFutureFile('source', 'target'));
}
}
Loading

0 comments on commit 876238c

Please sign in to comment.