1 files changed, 39 insertions, 55 deletions

diff --git a/core/Controller/NavigationController.php b/core/Controller/NavigationController.php
index 9d0565145c3..017061ef979 100644
--- a/core/Controller/NavigationController.php
+++ b/core/Controller/NavigationController.php
@@ -1,97 +1,83 @@
 <?php
+
 /**
- * @copyright Copyright (c) 2018 Julius Härtl <jus@bitgrid.net>
- *
- * @author Julius Härtl <jus@bitgrid.net>
- *
- * @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/>.
- *
+ * SPDX-FileCopyrightText: 2018 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 namespace OC\Core\Controller;
 
+use OC\Core\ResponseDefinitions;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\ApiRoute;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\OCSController;
 use OCP\INavigationManager;
 use OCP\IRequest;
 use OCP\IURLGenerator;
 
+/**
+ * @psalm-import-type CoreNavigationEntry from ResponseDefinitions
+ */
 class NavigationController extends OCSController {
-
-	/** @var INavigationManager */
-	private $navigationManager;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	public function __construct(string $appName, IRequest $request, INavigationManager $navigationManager, IURLGenerator $urlGenerator) {
+	public function __construct(
+		string $appName,
+		IRequest $request,
+		private INavigationManager $navigationManager,
+		private IURLGenerator $urlGenerator,
+	) {
 		parent::__construct($appName, $request);
-		$this->navigationManager = $navigationManager;
-		$this->urlGenerator = $urlGenerator;
 	}
 
 	/**
-	 * @NoAdminRequired
-	 * @NoCSRFRequired
+	 * Get the apps navigation
 	 *
-	 * @param bool $absolute
-	 * @return DataResponse
+	 * @param bool $absolute Rewrite URLs to absolute ones
+	 * @return DataResponse<Http::STATUS_OK, list<CoreNavigationEntry>, array{}>|DataResponse<Http::STATUS_NOT_MODIFIED, list<empty>, array{}>
+	 *
+	 * 200: Apps navigation returned
+	 * 304: No apps navigation changed
 	 */
+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	#[ApiRoute(verb: 'GET', url: '/navigation/apps', root: '/core')]
 	public function getAppsNavigation(bool $absolute = false): DataResponse {
 		$navigation = $this->navigationManager->getAll();
 		if ($absolute) {
 			$navigation = $this->rewriteToAbsoluteUrls($navigation);
 		}
 		$navigation = array_values($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($this->generateETag($navigation));
 		return $response;
 	}
 
 	/**
-	 * @NoAdminRequired
-	 * @NoCSRFRequired
+	 * Get the settings navigation
+	 *
+	 * @param bool $absolute Rewrite URLs to absolute ones
+	 * @return DataResponse<Http::STATUS_OK, list<CoreNavigationEntry>, array{}>|DataResponse<Http::STATUS_NOT_MODIFIED, list<empty>, array{}>
 	 *
-	 * @param bool $absolute
-	 * @return DataResponse
+	 * 200: Apps navigation returned
+	 * 304: No apps navigation changed
 	 */
+	#[NoAdminRequired]
+	#[NoCSRFRequired]
+	#[ApiRoute(verb: 'GET', url: '/navigation/settings', root: '/core')]
 	public function getSettingsNavigation(bool $absolute = false): DataResponse {
 		$navigation = $this->navigationManager->getAll('settings');
 		if ($absolute) {
 			$navigation = $this->rewriteToAbsoluteUrls($navigation);
 		}
 		$navigation = array_values($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($this->generateETag($navigation));
 		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) {
@@ -104,16 +90,14 @@ class NavigationController extends OCSController {
 
 	/**
 	 * Rewrite href attribute of navigation entries to an absolute URL
-	 *
-	 * @param array $navigation
-	 * @return array
 	 */
 	private function rewriteToAbsoluteUrls(array $navigation): array {
 		foreach ($navigation as &$entry) {
-			if (0 !== strpos($entry['href'], $this->urlGenerator->getBaseUrl())) {
+			/* If parse_url finds no host it means the URL is not absolute */
+			if (!isset(\parse_url($entry['href'])['host'])) {
 				$entry['href'] = $this->urlGenerator->getAbsoluteURL($entry['href']);
 			}
-			if (0 !== strpos($entry['icon'], $this->urlGenerator->getBaseUrl())) {
+			if (!str_starts_with($entry['icon'], $this->urlGenerator->getBaseUrl())) {
 				$entry['icon'] = $this->urlGenerator->getAbsoluteURL($entry['icon']);
 			}
 		}