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

Merge pull request #4995 from owncloud/move-aborted-upload-detection-into-plugin-master

Browse source 
Move aborted upload detection into it's own sabedav plugin
This commit is contained in:
Thomas Müller 2013-09-30 02:31:51 -07:00
commit ebb2278a67
4 changed files with 199 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
apps/files/appinfo/remote.php
View file

@ -48,6 +48,7 @@ $defaults = new OC_Defaults();
$server->addPlugin(new Sabre_DAV_Auth_Plugin($authBackend, $defaults->getName()));
$server->addPlugin(new Sabre_DAV_Locks_Plugin($lockBackend));
$server->addPlugin(new Sabre_DAV_Browser_Plugin(false)); // Show something in the Browser, but no upload
$server->addPlugin(new OC_Connector_Sabre_AbortedUploadDetectionPlugin());
$server->addPlugin(new OC_Connector_Sabre_QuotaPlugin());
$server->addPlugin(new OC_Connector_Sabre_MaintenancePlugin());

101
lib/connector/sabre/aborteduploaddetectionplugin.php Normal file
View file

@ -0,0 +1,101 @@
<?php
/**
* Copyright (c) 2013 Thomas Müller <thomas.mueller@tmit.eu>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
/**
* Class OC_Connector_Sabre_AbortedUploadDetectionPlugin
*
* This plugin will verify if the uploaded data has been stored completely.
* This is done by comparing the content length of the request with the file size on storage.
*/
class OC_Connector_Sabre_AbortedUploadDetectionPlugin extends Sabre_DAV_ServerPlugin {
/**
* Reference to main server object
*
* @var Sabre_DAV_Server
*/
private $server;
/**
* is kept public to allow overwrite for unit testing
*
* @var \OC\Files\View
*/
public $fileView;
/**
* This initializes the plugin.
*
* This function is called by Sabre_DAV_Server, after
* addPlugin is called.
*
* This method should set up the requires event subscriptions.
*
* @param Sabre_DAV_Server $server
*/
public function initialize(Sabre_DAV_Server $server) {
$this->server = $server;
$server->subscribeEvent('afterCreateFile', array($this, 'verifyContentLength'), 10);
$server->subscribeEvent('afterWriteContent', array($this, 'verifyContentLength'), 10);
}
/**
* @param $filePath
* @param Sabre_DAV_INode $node
* @throws Sabre_DAV_Exception_BadRequest
*/
public function verifyContentLength($filePath, Sabre_DAV_INode $node = null) {
// ownCloud chunked upload will be handled in its own plugin
$chunkHeader = $this->server->httpRequest->getHeader('OC-Chunked');
if ($chunkHeader) {
return;
}
// compare expected and actual size
$expected = $this->getLength();
if (!$expected) {
return;
}
$actual = $this->getFileView()->filesize($filePath);
if ($actual != $expected) {
$this->getFileView()->unlink($filePath);
throw new Sabre_DAV_Exception_BadRequest('expected filesize ' . $expected . ' got ' . $actual);
}
}
/**
* @return string
*/
public function getLength()
{
$req = $this->server->httpRequest;
$length = $req->getHeader('X-Expected-Entity-Length');
if (!$length) {
$length = $req->getHeader('Content-Length');
}
return $length;
}
/**
* @return \OC\Files\View
*/
public function getFileView()
{
if (is_null($this->fileView)) {
// initialize fileView
$this->fileView = \OC\Files\Filesystem::getView();
}
return $this->fileView;
}
}

13
lib/connector/sabre/directory.php
View file

@ -74,19 +74,6 @@ class OC_Connector_Sabre_Directory extends OC_Connector_Sabre_Node implements Sa
\OC\Files\Filesystem::file_put_contents($partpath, $data);
//detect aborted upload
if (isset ($_SERVER['REQUEST_METHOD']) && $_SERVER['REQUEST_METHOD'] === 'PUT' ) {
if (isset($_SERVER['CONTENT_LENGTH'])) {
$expected = $_SERVER['CONTENT_LENGTH'];
$actual = \OC\Files\Filesystem::filesize($partpath);
if ($actual != $expected) {
\OC\Files\Filesystem::unlink($partpath);
throw new Sabre_DAV_Exception_BadRequest(
'expected filesize ' . $expected . ' got ' . $actual);
}
}
}
// rename to correct path
$renameOkay = \OC\Files\Filesystem::rename($partpath, $newPath);
$fileExists = \OC\Files\Filesystem::file_exists($newPath);

97
tests/lib/connector/sabre/aborteduploaddetectionplugin.php Normal file
View file

@ -0,0 +1,97 @@
<?php
/**
* Copyright (c) 2013 Thomas Müller <thomas.mueller@tmit.eu>
* This file is licensed under the Affero General Public License version 3 or
* later.
* See the COPYING-README file.
*/
class Test_OC_Connector_Sabre_AbortedUploadDetectionPlugin extends PHPUnit_Framework_TestCase {
/**
* @var Sabre_DAV_Server
*/
private $server;
/**
* @var OC_Connector_Sabre_AbortedUploadDetectionPlugin
*/
private $plugin;
public function setUp() {
$this->server = new Sabre_DAV_Server();
$this->plugin = new OC_Connector_Sabre_AbortedUploadDetectionPlugin();
$this->plugin->initialize($this->server);
}
/**
* @dataProvider lengthProvider
*/
public function testLength($expected, $headers)
{
$this->server->httpRequest = new Sabre_HTTP_Request($headers);
$length = $this->plugin->getLength();
$this->assertEquals($expected, $length);
}
/**
* @dataProvider verifyContentLengthProvider
*/
public function testVerifyContentLength($fileSize, $headers)
{
$this->plugin->fileView = $this->buildFileViewMock($fileSize);
$this->server->httpRequest = new Sabre_HTTP_Request($headers);
$this->plugin->verifyContentLength('foo.txt');
$this->assertTrue(true);
}
/**
* @dataProvider verifyContentLengthFailedProvider
* @expectedException Sabre_DAV_Exception_BadRequest
*/
public function testVerifyContentLengthFailed($fileSize, $headers)
{
$this->plugin->fileView = $this->buildFileViewMock($fileSize);
// we expect unlink to be called
$this->plugin->fileView->expects($this->once())->method('unlink');
$this->server->httpRequest = new Sabre_HTTP_Request($headers);
$this->plugin->verifyContentLength('foo.txt');
}
public function verifyContentLengthProvider() {
return array(
array(1024, array()),
array(1024, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
array(512, array('HTTP_CONTENT_LENGTH' => '512')),
);
}
public function verifyContentLengthFailedProvider() {
return array(
array(1025, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
array(525, array('HTTP_CONTENT_LENGTH' => '512')),
);
}
public function lengthProvider() {
return array(
array(null, array()),
array(1024, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '1024')),
array(512, array('HTTP_CONTENT_LENGTH' => '512')),
array(2048, array('HTTP_X_EXPECTED_ENTITY_LENGTH' => '2048', 'HTTP_CONTENT_LENGTH' => '1024')),
);
}
private function buildFileViewMock($fileSize) {
// mock filesysten
$view = $this->getMock('\OC\Files\View', array('filesize', 'unlink'), array(), '', FALSE);
$view->expects($this->any())->method('filesize')->withAnyParameters()->will($this->returnValue($fileSize));
return $view;
}
}