From 7b6b9464705205807b985d68a8ee93abb47e79ca Mon Sep 17 00:00:00 2001 From: Roeland Jago Douma Date: Thu, 2 Apr 2020 15:17:04 +0200 Subject: [PATCH] Allow for compression of the PROPFIND responses For now it just gzip and only for propfind (the 99% case). Already saves a bunch since the propfinds compress so nicely. Signed-off-by: Roeland Jago Douma --- .../composer/composer/autoload_classmap.php | 1 + .../dav/composer/composer/autoload_static.php | 1 + .../Sabre/PropfindCompressionPlugin.php | 74 +++++++++++ apps/dav/lib/Server.php | 5 + .../Sabre/PropfindCompressionPluginTest.php | 116 ++++++++++++++++++ 5 files changed, 197 insertions(+) create mode 100644 apps/dav/lib/Connector/Sabre/PropfindCompressionPlugin.php create mode 100644 apps/dav/tests/unit/Connector/Sabre/PropfindCompressionPluginTest.php diff --git a/apps/dav/composer/composer/autoload_classmap.php b/apps/dav/composer/composer/autoload_classmap.php index 057f4dddfc..71cf0c1087 100644 --- a/apps/dav/composer/composer/autoload_classmap.php +++ b/apps/dav/composer/composer/autoload_classmap.php @@ -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', diff --git a/apps/dav/composer/composer/autoload_static.php b/apps/dav/composer/composer/autoload_static.php index ec553beb2b..c0ed98a03c 100644 --- a/apps/dav/composer/composer/autoload_static.php +++ b/apps/dav/composer/composer/autoload_static.php @@ -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', diff --git a/apps/dav/lib/Connector/Sabre/PropfindCompressionPlugin.php b/apps/dav/lib/Connector/Sabre/PropfindCompressionPlugin.php new file mode 100644 index 0000000000..a152950865 --- /dev/null +++ b/apps/dav/lib/Connector/Sabre/PropfindCompressionPlugin.php @@ -0,0 +1,74 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ + +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; + } +} diff --git a/apps/dav/lib/Server.php b/apps/dav/lib/Server.php index 46cac5ef87..e64abf43f7 100644 --- a/apps/dav/lib/Server.php +++ b/apps/dav/lib/Server.php @@ -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() { diff --git a/apps/dav/tests/unit/Connector/Sabre/PropfindCompressionPluginTest.php b/apps/dav/tests/unit/Connector/Sabre/PropfindCompressionPluginTest.php new file mode 100644 index 0000000000..a7cb8582bc --- /dev/null +++ b/apps/dav/tests/unit/Connector/Sabre/PropfindCompressionPluginTest.php @@ -0,0 +1,116 @@ + + * + * @author Roeland Jago Douma + * + * @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 . + * + */ + +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); + } +}