From 11b6cc3f68f55e1c5e725b737b39c0a7f79e0ec1 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Julius=20H=C3=A4rtl?= <jus@bitgrid.net>
Date: Mon, 5 Mar 2018 16:22:18 +0100
Subject: [PATCH] Replace logout href to avoid new etag on every request
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Julius Härtl <jus@bitgrid.net>
---
 core/Controller/NavigationController.php      | 23 +++++++++++++++----
 .../Controller/NavigationControllerTest.php   |  6 ++---
 2 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/core/Controller/NavigationController.php b/core/Controller/NavigationController.php
index b178cb97cd..2397fb3c7b 100644
--- a/core/Controller/NavigationController.php
+++ b/core/Controller/NavigationController.php
@@ -56,12 +56,12 @@ class NavigationController extends OCSController {
 			$navigation = $this->rewriteToAbsoluteUrls($navigation);
 		}
 
-		$etag = md5(json_encode($navigation));
+		$etag = $this->generateETag($navigation);
 		if ($this->request->getHeader('If-None-Match') === $etag) {
 			return new DataResponse([], Http::STATUS_NOT_MODIFIED);
 		}
 		$response = new DataResponse($navigation);
-		$response->setEtag($etag);
+		$response->setETag($etag);
 		return $response;
 	}
 
@@ -77,15 +77,30 @@ class NavigationController extends OCSController {
 		if ($absolute) {
 			$navigation = $this->rewriteToAbsoluteUrls($navigation);
 		}
-		$etag = md5(json_encode($navigation));
+		$etag = $this->generateETag($navigation);
 		if ($this->request->getHeader('If-None-Match') === $etag) {
 			return new DataResponse([], Http::STATUS_NOT_MODIFIED);
 		}
 		$response = new DataResponse($navigation);
-		$response->setEtag($etag);
+		$response->setETag($etag);
 		return $response;
 	}
 
+	/**
+	 * Generate an ETag for a list of navigation entries
+	 *
+	 * @param array $navigation
+	 * @return string
+	 */
+	private function generateETag(array $navigation): string {
+		foreach ($navigation as &$nav) {
+			if ($nav['id'] === 'logout') {
+				$nav['href'] = 'logout';
+			}
+		}
+		return md5(json_encode($navigation));
+	}
+
 	/**
 	 * Rewrite href attribute of navigation entries to an absolute URL
 	 *
diff --git a/tests/Core/Controller/NavigationControllerTest.php b/tests/Core/Controller/NavigationControllerTest.php
index ef4720604f..a33ddf7dd2 100644
--- a/tests/Core/Controller/NavigationControllerTest.php
+++ b/tests/Core/Controller/NavigationControllerTest.php
@@ -132,7 +132,7 @@ class NavigationControllerTest extends TestCase {
 		$this->request->expects($this->once())
 			->method('getHeader')
 			->with('If-None-Match')
-			->willReturn(md5(json_encode($navigation)));
+			->willReturn(md5(json_encode(['files'])));
 		$this->navigationManager->expects($this->once())
 			->method('getAll')
 			->with('link')
@@ -143,11 +143,11 @@ class NavigationControllerTest extends TestCase {
 	}
 
 	public function testGetSettingsNavigationEtagMatch() {
-		$navigation = [ ['id' => 'files', 'href' => '/index.php/apps/files', 'icon' => 'icon' ] ];
+		$navigation = [ ['id' => 'logout', 'href' => '/index.php/apps/files', 'icon' => 'icon' ] ];
 		$this->request->expects($this->once())
 			->method('getHeader')
 			->with('If-None-Match')
-			->willReturn(md5(json_encode($navigation)));
+			->willReturn(md5(json_encode([ ['id' => 'logout', 'href' => 'logout', 'icon' => 'icon' ] ])));
 		$this->navigationManager->expects($this->once())
 			->method('getAll')
 			->with('settings')