mbk-lab
/
nextcloud
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #20272 from nextcloud/enh/sabre/gzip_propfind 

Gzip the propfind response
This commit is contained in:
Roeland Jago Douma 2020-06-08 11:23:30 +02:00 committed by GitHub
parent c5a2caa0fb 7b6b946470
commit 9a196d12a8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 197 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
apps/dav/composer/composer/autoload_classmap.php
View File

@ -143,6 +143,7 @@ return array(
'OCA\\DAV\\Connector\\Sabre\\Node' => $baseDir . '/../lib/Connector/Sabre/Node.php',
'OCA\\DAV\\Connector\\Sabre\\ObjectTree' => $baseDir . '/../lib/Connector/Sabre/ObjectTree.php',
'OCA\\DAV\\Connector\\Sabre\\Principal' => $baseDir . '/../lib/Connector/Sabre/Principal.php',
'OCA\\DAV\\Connector\\Sabre\\PropfindCompressionPlugin' => $baseDir . '/../lib/Connector/Sabre/PropfindCompressionPlugin.php',
'OCA\\DAV\\Connector\\Sabre\\QuotaPlugin' => $baseDir . '/../lib/Connector/Sabre/QuotaPlugin.php',
'OCA\\DAV\\Connector\\Sabre\\Server' => $baseDir . '/../lib/Connector/Sabre/Server.php',
'OCA\\DAV\\Connector\\Sabre\\ServerFactory' => $baseDir . '/../lib/Connector/Sabre/ServerFactory.php',

1
apps/dav/composer/composer/autoload_static.php
View File

@ -158,6 +158,7 @@ class ComposerStaticInitDAV
'OCA\\DAV\\Connector\\Sabre\\Node' => __DIR__ . '/..' . '/../lib/Connector/Sabre/Node.php',
'OCA\\DAV\\Connector\\Sabre\\ObjectTree' => __DIR__ . '/..' . '/../lib/Connector/Sabre/ObjectTree.php',
'OCA\\DAV\\Connector\\Sabre\\Principal' => __DIR__ . '/..' . '/../lib/Connector/Sabre/Principal.php',
'OCA\\DAV\\Connector\\Sabre\\PropfindCompressionPlugin' => __DIR__ . '/..' . '/../lib/Connector/Sabre/PropfindCompressionPlugin.php',
'OCA\\DAV\\Connector\\Sabre\\QuotaPlugin' => __DIR__ . '/..' . '/../lib/Connector/Sabre/QuotaPlugin.php',
'OCA\\DAV\\Connector\\Sabre\\Server' => __DIR__ . '/..' . '/../lib/Connector/Sabre/Server.php',
'OCA\\DAV\\Connector\\Sabre\\ServerFactory' => __DIR__ . '/..' . '/../lib/Connector/Sabre/ServerFactory.php',

74
apps/dav/lib/Connector/Sabre/PropfindCompressionPlugin.php Normal file
View File

@ -0,0 +1,74 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020, Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\DAV\Connector\Sabre;
use Sabre\DAV\ServerPlugin;
use Sabre\HTTP\Request;
use Sabre\HTTP\Response;
class PropfindCompressionPlugin extends ServerPlugin {
/**
* Reference to main server object
*
* @var Server
*/
private $server;
/**
* This initializes the plugin.
*
* This function is called by \Sabre\DAV\Server, after
* addPlugin is called.
*
* This method should set up the required event subscriptions.
*
* @param \Sabre\DAV\Server $server
* @return void
*/
public function initialize(\Sabre\DAV\Server $server) {
$this->server = $server;
$this->server->on('afterMethod:PROPFIND', [$this, 'compressResponse'], 100);
}
public function compressResponse(Request $request, Response $response) {
$header = $request->getHeader('Accept-Encoding');
if ($header === null) {
return $response;
}
if (strpos($header, 'gzip') !== false) {
$body = $response->getBody();
if (is_string($body)) {
$response->setHeader('Content-Encoding', 'gzip');
$response->setBody(gzencode($body));
}
}
return $response;
}
}

5
apps/dav/lib/Server.php
View File

@ -54,6 +54,7 @@ use OCA\DAV\Connector\Sabre\DummyGetResponsePlugin;
use OCA\DAV\Connector\Sabre\FakeLockerPlugin;
use OCA\DAV\Connector\Sabre\FilesPlugin;
use OCA\DAV\Connector\Sabre\FilesReportPlugin;
use OCA\DAV\Connector\Sabre\PropfindCompressionPlugin;
use OCA\DAV\Connector\Sabre\QuotaPlugin;
use OCA\DAV\Connector\Sabre\SharesPlugin;
use OCA\DAV\Connector\Sabre\TagsPlugin;
@ -314,6 +315,10 @@ class Server {
$root->addChild($appCollection);
}
});
$this->server->addPlugin(
new PropfindCompressionPlugin()
);
}
public function exec() {

116
apps/dav/tests/unit/Connector/Sabre/PropfindCompressionPluginTest.php Normal file
View File

@ -0,0 +1,116 @@
<?php
declare(strict_types=1);
/**
* @copyright Copyright (c) 2020, Roeland Jago Douma <roeland@famdouma.nl>
*
* @author Roeland Jago Douma <roeland@famdouma.nl>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* 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
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
namespace OCA\DAV\Tests\unit\Connector\Sabre;
use OCA\DAV\Connector\Sabre\PropfindCompressionPlugin;
use Sabre\HTTP\Request;
use Sabre\HTTP\Response;
use Test\TestCase;
class PropfindCompressionPluginTest extends TestCase {
/** @var PropfindCompressionPlugin */
private $plugin;
protected function setUp(): void {
parent::setUp();
$this->plugin = new PropfindCompressionPlugin();
}
public function testNoHeader() {
$request = $this->createMock(Request::class);
$response = $this->createMock(Response::class);
$request->method('getHeader')
->with('Accept-Encoding')
->willReturn(null);
$response->expects($this->never())
->method($this->anything());
$result = $this->plugin->compressResponse($request, $response);
$this->assertSame($response, $result);
}
public function testHeaderButNoGzip() {
$request = $this->createMock(Request::class);
$response = $this->createMock(Response::class);
$request->method('getHeader')
->with('Accept-Encoding')
->willReturn('deflate');
$response->expects($this->never())
->method($this->anything());
$result = $this->plugin->compressResponse($request, $response);
$this->assertSame($response, $result);
}
public function testHeaderGzipButNoStringBody() {
$request = $this->createMock(Request::class);
$response = $this->createMock(Response::class);
$request->method('getHeader')
->with('Accept-Encoding')
->willReturn('deflate');
$response->method('getBody')
->willReturn(5);
$result = $this->plugin->compressResponse($request, $response);
$this->assertSame($response, $result);
}
public function testProperGzip() {
$request = $this->createMock(Request::class);
$response = $this->createMock(Response::class);
$request->method('getHeader')
->with('Accept-Encoding')
->willReturn('gzip, deflate');
$response->method('getBody')
->willReturn('my gzip test');
$response->expects($this->once())
->method('setHeader')
->with(
$this->equalTo('Content-Encoding'),
$this->equalTo('gzip')
);
$response->expects($this->once())
->method('setBody')
->with($this->callback(function ($data) {
$orig = gzdecode($data);
return $orig === 'my gzip test';
}));
$result = $this->plugin->compressResponse($request, $response);
$this->assertSame($response, $result);
}
}