feat: add command to list all routes registered

Signed-off-by: Ferdinand Thiessen <[email protected]>

Author: susnux

core/Command/Router/ListRoutes.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC\Core\Command\Router;
+
+use OC\Core\Command\Base;
+use OC\Route\Route;
+use OC\Route\Router;
+use OCP\App\IAppManager;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ListRoutes extends Base {
+
+	private InputInterface $input;
+
+	public function __construct(
+		private IAppManager $appManager,
+		private Router $router,
+	) {
+		parent::__construct();
+	}
+
+	protected function configure(): void {
+		parent::configure();
+		$this
+			->setName('router:list')
+			->setDescription('List registered routes')
+			->addArgument('appId', InputArgument::OPTIONAL, 'Limit routes to specific app', '')
+			->addOption('grouped', 'g', InputOption::VALUE_NONE, 'Group routes by app');
+	}
+
+	protected function execute(InputInterface $input, OutputInterface $output): int {
+		$this->input = $input;
+
+		$app = (string)$input->getArgument('appId');
+		$apps = $app === '' ? $this->appManager->getEnabledApps() : [$app];
+
+		$this->router->loadRoutes();
+		$allRoutes = [];
+		foreach ($apps as $appId) {
+			$routes = $this->router->getCollection($appId)->all();
+			$routes = array_merge($routes, $this->router->getCollection("$appId.ocs")->all());
+			$allRoutes = array_merge($allRoutes, $routes);
+
+			if (!empty($routes) && $input->getOption('grouped')) {
+				$output->writeln("\nRoutes of $appId:");
+				$rows = $this->formatRoutes($routes);
+				$this->writeTableInOutputFormat($input, $output, $rows);
+			}
+		}
+		if (!$input->getOption('grouped')) {
+			$rows = $this->formatRoutes($allRoutes);
+			$this->writeTableInOutputFormat($input, $output, $rows);
+		}
+		return 0;
+	}
+
+	/**
+	 * @param Route[] $routes
+	 */
+	private function formatRoutes(array $routes): array {
+		$rows = [];
+		foreach ($routes as $route) {
+			[$realApp, $controller, $function] = $route->getDefault('caller');
+			//print_r($route->__serialize());
+			$rows[] = [
+				'app' => $realApp,
+				'controller' => $controller,
+				'function' => $function,
+				'method' => $route->getMethods()[0],
+				'path' => str_replace('/ocsapp', '/ocs/v2.php', $route->getPath()),
+				'defaults' => $this->formatDefaults($route->getDefaults()),
+				'requirements' => $this->formatArray($route->getRequirements()),
+			];
+		}
+		return $rows;
+	}
+
+	private function formatDefaults(array $defaults): array|string {
+		$defaults = array_filter($defaults, fn (string $name) => !in_array($name, ['action', 'caller']), ARRAY_FILTER_USE_KEY);
+		return $this->formatArray($defaults);
+	}
+
+	private function formatArray(array $value): array|string {
+		if (str_starts_with($this->input->getOption('output'), self::OUTPUT_FORMAT_JSON)) {
+			return $value;
+		}
+		return empty($value) ? '' : json_encode($value);
+	}
+}

core/register_command.php

@@ -71,6 +71,7 @@
 use OC\Core\Command\Memcache\RedisCommand;
 use OC\Core\Command\Preview\Generate;
 use OC\Core\Command\Preview\ResetRenderedTexts;
+use OC\Core\Command\Router\ListRoutes;
 use OC\Core\Command\Security\BruteforceAttempts;
 use OC\Core\Command\Security\BruteforceResetAttempts;
 use OC\Core\Command\Security\ExportCertificates;
@@ -243,6 +244,8 @@
 	$application->add(Server::get(Statistics::class));
 
 	$application->add(Server::get(RedisCommand::class));
+
+	$application->add(Server::get(ListRoutes::class));
 } else {
 	$application->add(Server::get(Command\Maintenance\Install::class));
 }

lib/composer/composer/autoload_classmap.php

@@ -1290,6 +1290,7 @@
     'OC\\Core\\Command\\Preview\\Generate' => $baseDir . '/core/Command/Preview/Generate.php',
     'OC\\Core\\Command\\Preview\\Repair' => $baseDir . '/core/Command/Preview/Repair.php',
     'OC\\Core\\Command\\Preview\\ResetRenderedTexts' => $baseDir . '/core/Command/Preview/ResetRenderedTexts.php',
+    'OC\\Core\\Command\\Router\\ListRoutes' => $baseDir . '/core/Command/Router/ListRoutes.php',
     'OC\\Core\\Command\\Security\\BruteforceAttempts' => $baseDir . '/core/Command/Security/BruteforceAttempts.php',
     'OC\\Core\\Command\\Security\\BruteforceResetAttempts' => $baseDir . '/core/Command/Security/BruteforceResetAttempts.php',
     'OC\\Core\\Command\\Security\\ExportCertificates' => $baseDir . '/core/Command/Security/ExportCertificates.php',

lib/composer/composer/autoload_static.php

@@ -1331,6 +1331,7 @@ class ComposerStaticInit749170dad3f5e7f9ca158f5a9f04f6a2
         'OC\\Core\\Command\\Preview\\Generate' => __DIR__ . '/../../..' . '/core/Command/Preview/Generate.php',
         'OC\\Core\\Command\\Preview\\Repair' => __DIR__ . '/../../..' . '/core/Command/Preview/Repair.php',
         'OC\\Core\\Command\\Preview\\ResetRenderedTexts' => __DIR__ . '/../../..' . '/core/Command/Preview/ResetRenderedTexts.php',
+        'OC\\Core\\Command\\Router\\ListRoutes' => __DIR__ . '/../../..' . '/core/Command/Router/ListRoutes.php',
         'OC\\Core\\Command\\Security\\BruteforceAttempts' => __DIR__ . '/../../..' . '/core/Command/Security/BruteforceAttempts.php',
         'OC\\Core\\Command\\Security\\BruteforceResetAttempts' => __DIR__ . '/../../..' . '/core/Command/Security/BruteforceResetAttempts.php',
         'OC\\Core\\Command\\Security\\ExportCertificates' => __DIR__ . '/../../..' . '/core/Command/Security/ExportCertificates.php',