'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\\NotModifiedMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/NotModifiedMiddleware.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',
'OC\\AppFramework\\Middleware\\PublicShare\\PublicShareMiddleware' => $baseDir . '/lib/private/AppFramework/Middleware/PublicShare/PublicShareMiddleware.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\\NotModifiedMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/NotModifiedMiddleware.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',
'OC\\AppFramework\\Middleware\\PublicShare\\PublicShareMiddleware' => __DIR__ . '/../../..' . '/lib/private/AppFramework/Middleware/PublicShare/PublicShareMiddleware.php',
$c->query(OC\AppFramework\Middleware\CompressionMiddleware::class)
);
+ $dispatcher->registerMiddleware($c->query(OC\AppFramework\Middleware\NotModifiedMiddleware::class));
+
$dispatcher->registerMiddleware(
$c->query(OC\AppFramework\Middleware\Security\ReloadExecutionMiddleware::class)
);
* @param string $ETag the etag
* @return string
*/
- public function getStatusHeader($status, \DateTime $lastModified=null,
- $ETag=null) {
- if (!is_null($lastModified)) {
- $lastModified = $lastModified->format(\DateTime::RFC2822);
- }
-
- // if etag or lastmodified have not changed, return a not modified
- if ((isset($this->server['HTTP_IF_NONE_MATCH'])
- && trim(trim($this->server['HTTP_IF_NONE_MATCH']), '"') === (string)$ETag)
-
- ||
-
- (isset($this->server['HTTP_IF_MODIFIED_SINCE'])
- && trim($this->server['HTTP_IF_MODIFIED_SINCE']) ===
- $lastModified)) {
- $status = self::STATUS_NOT_MODIFIED;
- }
-
+ public function getStatusHeader($status) {
// we have one change currently for the http 1.0 header that differs
// from 1.1: STATUS_TEMPORARY_REDIRECT should be STATUS_FOUND
// if this differs any more, we want to create childclasses for this
$controller, $methodName, $response);
// depending on the cache object the headers need to be changed
- $out[0] = $this->protocol->getStatusHeader($response->getStatus(),
- $response->getLastModified(), $response->getETag());
+ $out[0] = $this->protocol->getStatusHeader($response->getStatus());
$out[1] = array_merge($response->getHeaders());
$out[2] = $response->getCookies();
$out[3] = $this->middlewareDispatcher->beforeOutput(
--- /dev/null
+<?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 OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Response;
+use OCP\AppFramework\Middleware;
+use OCP\IRequest;
+
+class NotModifiedMiddleware extends Middleware {
+ /** @var IRequest */
+ private $request;
+
+ public function __construct(IRequest $request) {
+ $this->request = $request;
+ }
+
+ public function afterController($controller, $methodName, Response $response) {
+ $etagHeader = $this->request->getHeader('IF_NONE_MATCH');
+ if ($etagHeader !== '' && $response->getETag() !== null && trim($etagHeader) === '"' . $response->getETag() . '"') {
+ $response->setStatus(Http::STATUS_NOT_MODIFIED);
+ return $response;
+ }
+
+ $modifiedSinceHeader = $this->request->getHeader('IF_MODIFIED_SINCE');
+ if ($modifiedSinceHeader !== '' && $response->getLastModified() !== null && trim($modifiedSinceHeader) === $response->getLastModified()->format(\DateTime::RFC2822)) {
+ $response->setStatus(Http::STATUS_NOT_MODIFIED);
+ return $response;
+ }
+
+ return $response;
+ }
+}
$this->response->expects($this->once())
->method('getStatus')
->willReturn(Http::STATUS_OK);
- $this->response->expects($this->once())
- ->method('getLastModified')
- ->willReturn($this->lastModified);
- $this->response->expects($this->once())
- ->method('getETag')
- ->willReturn($this->etag);
$this->response->expects($this->once())
->method('getHeaders')
->willReturn($responseHeaders);
$this->http->expects($this->once())
->method('getStatusHeader')
- ->with($this->equalTo(Http::STATUS_OK),
- $this->equalTo($this->lastModified),
- $this->equalTo($this->etag))
+ ->with($this->equalTo(Http::STATUS_OK))
->willReturn($httpHeaders);
$this->middlewareDispatcher->expects($this->once())
$this->assertEquals('HTTP/1.0 200 OK', $header);
}
-
- public function testEtagMatchReturnsNotModified() {
- $http = new Http(['HTTP_IF_NONE_MATCH' => 'hi']);
-
- $header = $http->getStatusHeader(Http::STATUS_OK, null, 'hi');
- $this->assertEquals('HTTP/1.1 304 Not Modified', $header);
- }
-
-
- public function testQuotedEtagMatchReturnsNotModified() {
- $http = new Http(['HTTP_IF_NONE_MATCH' => '"hi"']);
-
- $header = $http->getStatusHeader(Http::STATUS_OK, null, 'hi');
- $this->assertEquals('HTTP/1.1 304 Not Modified', $header);
- }
-
-
- public function testLastModifiedMatchReturnsNotModified() {
- $dateTime = new \DateTime(null, new \DateTimeZone('GMT'));
- $dateTime->setTimestamp('12');
-
- $http = new Http(
- [
- 'HTTP_IF_MODIFIED_SINCE' => 'Thu, 01 Jan 1970 00:00:12 +0000']
- );
-
- $header = $http->getStatusHeader(Http::STATUS_OK, $dateTime);
- $this->assertEquals('HTTP/1.1 304 Not Modified', $header);
- }
-
-
-
public function testTempRedirectBecomesFoundInHttp10() {
$http = new Http([], 'HTTP/1.0');
--- /dev/null
+<?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\NotModifiedMiddleware;
+use OCP\AppFramework\Controller;
+use OCP\AppFramework\Http;
+use OCP\IRequest;
+
+class NotModifiedMiddlewareTest extends \Test\TestCase {
+
+ /** @var IRequest */
+ private $request;
+ /** @var Controller */
+ private $controller;
+ /** @var NotModifiedMiddleware */
+ private $middleWare;
+
+ protected function setUp(): void {
+ parent::setUp();
+
+ $this->request = $this->createMock(IRequest::class);
+ $this->middleWare = new NotModifiedMiddleware(
+ $this->request
+ );
+
+ $this->controller = $this->createMock(Controller::class);
+ }
+
+ public function dataModified(): array {
+ $now = new \DateTime();
+
+ return [
+ [null, '', null, '', false],
+ ['etag', 'etag', null, '', false],
+ ['etag', '"wrongetag"', null, '', false],
+ ['etag', '', null, '', false],
+ [null, '"etag"', null, '', false],
+ ['etag', '"etag"', null, '', true],
+
+ [null, '', $now, $now->format(\DateTime::RFC2822), true],
+ [null, '', $now, $now->format(\DateTime::ATOM), false],
+ [null, '', null, $now->format(\DateTime::RFC2822), false],
+ [null, '', $now, '', false],
+
+ ['etag', '"etag"', $now, $now->format(\DateTime::ATOM), true],
+ ['etag', '"etag"', $now, $now->format(\DateTime::RFC2822), true],
+ ];
+ }
+
+ /**
+ * @dataProvider dataModified
+ */
+ public function testMiddleware(?string $etag, string $etagHeader, ?\DateTime $lastModified, string $lastModifiedHeader, bool $notModifiedSet) {
+ $this->request->method('getHeader')
+ ->willReturnCallback(function (string $name) use ($etagHeader, $lastModifiedHeader) {
+ if ($name === 'IF_NONE_MATCH') {
+ return $etagHeader;
+ }
+ if ($name === 'IF_MODIFIED_SINCE') {
+ return $lastModifiedHeader;
+ }
+ return '';
+ });
+
+ $response = new Http\Response();
+ if ($etag !== null) {
+ $response->setETag($etag);
+ }
+ if ($lastModified !== null) {
+ $response->setLastModified($lastModified);
+ }
+ $response->setStatus(Http::STATUS_OK);
+
+ $result = $this->middleWare->afterController($this->controller, 'myfunction', $response);
+
+ if ($notModifiedSet) {
+ $this->assertSame(Http::STATUS_NOT_MODIFIED, $result->getStatus());
+ } else {
+ $this->assertSame(Http::STATUS_OK, $result->getStatus());
+ }
+ }
+}
projects / nextcloud-server.git / commitdiff