Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>tags/v19.0.0RC2
@@ -530,6 +530,7 @@ return array( | |||
'OC\\AppFramework\\Http\\Request' => $baseDir . '/lib/private/AppFramework/Http/Request.php', | |||
'OC\\AppFramework\\Logger' => $baseDir . '/lib/private/AppFramework/Logger.php', | |||
'OC\\AppFramework\\Middleware\\AdditionalScriptsMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/AdditionalScriptsMiddleware.php', | |||
'OC\\AppFramework\\Middleware\\CompressionMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/CompressionMiddleware.php', | |||
'OC\\AppFramework\\Middleware\\MiddlewareDispatcher' => $baseDir . '/lib/private/AppFramework/Middleware/MiddlewareDispatcher.php', | |||
'OC\\AppFramework\\Middleware\\OCSMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/OCSMiddleware.php', | |||
'OC\\AppFramework\\Middleware\\PublicShare\\Exceptions\\NeedAuthenticationException' => $baseDir . '/lib/private/AppFramework/Middleware/PublicShare/Exceptions/NeedAuthenticationException.php', |
@@ -559,6 +559,7 @@ class ComposerStaticInit53792487c5a8370acc0b06b1a864ff4c | |||
'OC\\AppFramework\\Http\\Request' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Http/Request.php', | |||
'OC\\AppFramework\\Logger' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Logger.php', | |||
'OC\\AppFramework\\Middleware\\AdditionalScriptsMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/AdditionalScriptsMiddleware.php', | |||
'OC\\AppFramework\\Middleware\\CompressionMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/CompressionMiddleware.php', | |||
'OC\\AppFramework\\Middleware\\MiddlewareDispatcher' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/MiddlewareDispatcher.php', | |||
'OC\\AppFramework\\Middleware\\OCSMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/OCSMiddleware.php', | |||
'OC\\AppFramework\\Middleware\\PublicShare\\Exceptions\\NeedAuthenticationException' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/PublicShare/Exceptions/NeedAuthenticationException.php', |
@@ -183,6 +183,11 @@ class DIContainer extends SimpleContainer implements IAppContainer { | |||
$server = $this->getServer(); | |||
$dispatcher = new MiddlewareDispatcher(); | |||
$dispatcher->registerMiddleware( | |||
$c->query(OC\AppFramework\Middleware\CompressionMiddleware::class) | |||
); | |||
$dispatcher->registerMiddleware( | |||
$c->query(OC\AppFramework\Middleware\Security\ReloadExecutionMiddleware::class) | |||
); |
@@ -0,0 +1,86 @@ | |||
<?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 OC\AppFramework\Middleware; | |||
use OC\AppFramework\OCS\BaseResponse; | |||
use OCP\AppFramework\Http; | |||
use OCP\AppFramework\Http\JSONResponse; | |||
use OCP\AppFramework\Http\Response; | |||
use OCP\AppFramework\Middleware; | |||
use OCP\IRequest; | |||
class CompressionMiddleware extends Middleware { | |||
/** @var bool */ | |||
private $useGZip; | |||
/** @var IRequest */ | |||
private $request; | |||
public function __construct(IRequest $request) { | |||
$this->request = $request; | |||
$this->useGZip = false; | |||
} | |||
public function afterController($controller, $methodName, Response $response) { | |||
// By default we do not gzip | |||
$allowGzip = false; | |||
// Only return gzipped content for 200 responses | |||
if ($response->getStatus() !== Http::STATUS_OK) { | |||
return $response; | |||
} | |||
// Check if we are even asked for gzip | |||
$header = $this->request->getHeader('Accept-Encoding'); | |||
if (strpos($header, 'gzip') === false) { | |||
return $response; | |||
} | |||
// We only allow gzip in some cases | |||
if ($response instanceof BaseResponse) { | |||
$allowGzip = true; | |||
} | |||
if ($response instanceof JSONResponse) { | |||
$allowGzip = true; | |||
} | |||
if ($allowGzip) { | |||
$this->useGZip = true; | |||
$response->addHeader('Content-Encoding', 'gzip'); | |||
} | |||
return $response; | |||
} | |||
public function beforeOutput($controller, $methodName, $output) { | |||
if (!$this->useGZip) { | |||
return $output; | |||
} | |||
return gzencode($output); | |||
} | |||
} |
@@ -0,0 +1,163 @@ | |||
<?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 Test\AppFramework\Middleware; | |||
use OC\AppFramework\Middleware\CompressionMiddleware; | |||
use OC\AppFramework\OCS\V1Response; | |||
use OC\AppFramework\OCS\V2Response; | |||
use OCP\AppFramework\Controller; | |||
use OCP\AppFramework\Http; | |||
use OCP\AppFramework\Http\DataResponse; | |||
use OCP\AppFramework\Http\JSONResponse; | |||
use OCP\IRequest; | |||
class CompressionMiddlewareTest extends \Test\TestCase { | |||
/** @var IRequest */ | |||
private $request; | |||
/** @var Controller */ | |||
private $controller; | |||
/** @var CompressionMiddleware */ | |||
private $middleWare; | |||
protected function setUp(): void { | |||
parent::setUp(); | |||
$this->request = $this->createMock(IRequest::class); | |||
$this->middleWare = new CompressionMiddleware( | |||
$this->request | |||
); | |||
$this->controller = $this->createMock(Controller::class); | |||
} | |||
public function testGzipOCSV1() { | |||
$this->request->method('getHeader') | |||
->with('Accept-Encoding') | |||
->willReturn('gzip'); | |||
$response = $this->createMock(V1Response::class); | |||
$response->expects($this->once()) | |||
->method('addHeader') | |||
->with('Content-Encoding', 'gzip'); | |||
$response->method('getStatus') | |||
->willReturn(Http::STATUS_OK); | |||
$this->middleWare->beforeController($this->controller, 'myMethod'); | |||
$this->middleWare->afterController($this->controller,'myMethod', $response); | |||
$output = 'myoutput'; | |||
$result = $this->middleWare->beforeOutput($this->controller, 'myMethod', $output); | |||
$this->assertSame($output, gzdecode($result)); | |||
} | |||
public function testGzipOCSV2() { | |||
$this->request->method('getHeader') | |||
->with('Accept-Encoding') | |||
->willReturn('gzip'); | |||
$response = $this->createMock(V2Response::class); | |||
$response->expects($this->once()) | |||
->method('addHeader') | |||
->with('Content-Encoding', 'gzip'); | |||
$response->method('getStatus') | |||
->willReturn(Http::STATUS_OK); | |||
$this->middleWare->beforeController($this->controller, 'myMethod'); | |||
$this->middleWare->afterController($this->controller,'myMethod', $response); | |||
$output = 'myoutput'; | |||
$result = $this->middleWare->beforeOutput($this->controller, 'myMethod', $output); | |||
$this->assertSame($output, gzdecode($result)); | |||
} | |||
public function testGzipJSONResponse() { | |||
$this->request->method('getHeader') | |||
->with('Accept-Encoding') | |||
->willReturn('gzip'); | |||
$response = $this->createMock(JSONResponse::class); | |||
$response->expects($this->once()) | |||
->method('addHeader') | |||
->with('Content-Encoding', 'gzip'); | |||
$response->method('getStatus') | |||
->willReturn(Http::STATUS_OK); | |||
$this->middleWare->beforeController($this->controller, 'myMethod'); | |||
$this->middleWare->afterController($this->controller,'myMethod', $response); | |||
$output = 'myoutput'; | |||
$result = $this->middleWare->beforeOutput($this->controller, 'myMethod', $output); | |||
$this->assertSame($output, gzdecode($result)); | |||
} | |||
public function testNoGzipDataResponse() { | |||
$this->request->method('getHeader') | |||
->with('Accept-Encoding') | |||
->willReturn('gzip'); | |||
$response = $this->createMock(DataResponse::class); | |||
$response->expects($this->never()) | |||
->method('addHeader'); | |||
$response->method('getStatus') | |||
->willReturn(Http::STATUS_OK); | |||
$this->middleWare->beforeController($this->controller, 'myMethod'); | |||
$this->middleWare->afterController($this->controller,'myMethod', $response); | |||
$output = 'myoutput'; | |||
$result = $this->middleWare->beforeOutput($this->controller, 'myMethod', $output); | |||
$this->assertSame($output, $result); | |||
} | |||
public function testNoGzipNo200() { | |||
$this->request->method('getHeader') | |||
->with('Accept-Encoding') | |||
->willReturn('gzip'); | |||
$response = $this->createMock(JSONResponse::class); | |||
$response->expects($this->never()) | |||
->method('addHeader'); | |||
$response->method('getStatus') | |||
->willReturn(Http::STATUS_NOT_FOUND); | |||
$this->middleWare->beforeController($this->controller, 'myMethod'); | |||
$this->middleWare->afterController($this->controller,'myMethod', $response); | |||
$output = 'myoutput'; | |||
$result = $this->middleWare->beforeOutput($this->controller, 'myMethod', $output); | |||
$this->assertSame($output, $result); | |||
} | |||
} |