Only load routes of the app which is requested

* Add fallback to load all routes if needed
* Move partial loaded routes test to proper place

The change for the routes to be loaded via include instead of include_once is to allow it to properl load them in the unit tests as they re-initiate the routes during the same execution cycle.

Signed-off-by: Morris Jobke <hey@morrisjobke.de>

Author: MorrisJobke

lib/private/Route/Router.php

@@ -328,13 +328,27 @@ public function getGenerator() {
 	public function generate($name,
 							 $parameters = [],
 							 $absolute = false) {
+		$referenceType = UrlGenerator::ABSOLUTE_URL;
+		if ($absolute === false) {
+			$referenceType = UrlGenerator::ABSOLUTE_PATH;
+		}
+		$name = $this->fixLegacyRootName($name);
+		if (strpos($name, '.') !== false) {
+			list($appName, $other) = explode('.', $name, 3);
+			// OCS routes are prefixed with "ocs."
+			if ($appName === 'ocs') {
+				$appName = $other;
+			}
+			$this->loadRoutes($appName);
+			try {
+				return $this->getGenerator()->generate($name, $parameters, $referenceType);
+			} catch (RouteNotFoundException $e) {
+			}
+		}
+
+		// Fallback load all routes
 		$this->loadRoutes();
 		try {
-			$referenceType = UrlGenerator::ABSOLUTE_URL;
-			if ($absolute === false) {
-				$referenceType = UrlGenerator::ABSOLUTE_PATH;
-			}
-			$name = $this->fixLegacyRootName($name);
 			return $this->getGenerator()->generate($name, $parameters, $referenceType);
 		} catch (RouteNotFoundException $e) {
 			$this->logger->logException($e);
@@ -377,7 +391,7 @@ protected function fixLegacyRootName(string $routeName): string {
 	 * @param string $appName
 	 */
 	private function requireRouteFile($file, $appName) {
-		$this->setupRoutes(include_once $file, $appName);
+		$this->setupRoutes(include $file, $appName);
 	}
 
 

tests/lib/Route/RouterTest.php

@@ -0,0 +1,68 @@
+<?php
+declare(strict_types=1);
+/**
+ * @copyright Copyright (c) 2019 Morris Jobke <hey@morrisjobke.de>
+ *
+ * @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\Route;
+
+use OC\Route\Router;
+use OCP\ILogger;
+use Test\TestCase;
+
+/**
+ * Class RouterTest
+ *
+ * @package Test\Route
+ */
+class RouterTest extends TestCase {
+	public function generateRouteProvider(): array {
+		return [
+			['files.view.index', '/index.php/apps/files/'],
+			// the OCS route is the prefixed one for the AppFramework - see /ocs/v1.php for routing details
+			['ocs.dav.direct.getUrl', '/index.php/ocsapp/apps/dav/api/v1/direct'],
+			// special route name - should load all apps and then find the route
+			['files_ajax_list', '/index.php/apps/files/ajax/list.php'],
+		];
+	}
+
+	/**
+	 * @dataProvider generateRouteProvider
+	 * @param $routeName
+	 * @param $expected
+	 */
+	public function testGenerate($routeName, $expected): void {
+		/** @var ILogger $logger */
+		$logger = $this->createMock(ILogger::class);
+		$router = new Router($logger);
+
+		$this->assertEquals($expected, $router->generate($routeName));
+	}
+
+	public function testGenerateTwice(): void {
+		/** @var ILogger $logger */
+		$logger = $this->createMock(ILogger::class);
+		$router = new Router($logger);
+
+		$this->assertEquals('/index.php/apps/files/', $router->generate('files.view.index'));
+		$this->assertEquals('/index.php/ocsapp/apps/dav/api/v1/direct', $router->generate('ocs.dav.direct.getUrl'));
+		$this->assertEquals('/index.php/apps/files/ajax/list.php', $router->generate('files_ajax_list'));
+		$this->assertEquals('/index.php/apps/files/', $router->generate('files.view.index'));
+	}
+}

tests/lib/UrlGeneratorTest.php

@@ -15,6 +15,8 @@
 
 /**
  * Class UrlGeneratorTest
+ *
+ * @package Test
  */
 class UrlGeneratorTest extends \Test\TestCase {
 
@@ -90,8 +92,8 @@ public function testLinkToRouteAbsolute($route, $expected) {
 
 	public function provideRoutes() {
 		return [
-			['files_ajax_list', 'http://localhost/nextcloud/index.php/apps/files/ajax/list.php'],
 			['core.Preview.getPreview', 'http://localhost/nextcloud/index.php/core/preview.png'],
+			['cloud_federation_api.requesthandlercontroller.addShare', 'http://localhost/nextcloud/index.php/ocm/shares'],
 		];
 	}