feat: add OCC command to list all routes (incl. fixing the Router) by susnux · Pull Request #52919 · nextcloud/server

susnux · 2025-05-16T23:00:54Z

Summary

Main idea was to add a command to list all registered routes, to make the annotation more usable.
But when doing so I noticed the Router is broken as retrieving individual collections of routes was broken,
so this also contains a fix for it:

Add routes to individual collections for each app
and then merge them for the root collection holding all routes for the
URL generator.
Short cut route loading with already loaded apps
Simplify active collection handling
Remove deprecated OC_App usage
Fully type Router methods

Checklist

Code is properly formatted
Sign-off message is added to all commits
Tests (unit, integration, api and/or acceptance) are included
Screenshots before/after for front-end changes
Documentation (manuals or wiki) has been updated or is not required
Backports requested where applicable (ex: critical bugfixes)

kesselb · 2025-05-17T13:26:22Z

+	protected function configure(): void {
+ parent::configure();
+ $this
+ ->setName('router:list')


#[AsCommand( name: 'router:list', description: 'List registered routes', )]
nit

kesselb · 2025-05-17T13:27:32Z

+ $rows = $this->formatRoutes($allRoutes);
+ $this->writeTableInOutputFormat($input, $output, $rows);
+ }
+ return 0;


Suggested change
return0;
returnself::SUCCESS;

kesselb · 2025-05-17T13:45:49Z

+ $apps = $user === null
+ ? $this->appManager->getEnabledApps()
+ : $this->appManager->getEnabledAppsForUser($user);


Suggested change
$apps = $user === null
? $this->appManager->getEnabledApps()
: $this->appManager->getEnabledAppsForUser($user);
if ($user === null) {
$apps = $this->appManager->getEnabledApps();
} else {
$apps = $this->appManager->getEnabledAppsForUser($user);
}
I would like to suggest using a normal if-else statement here instead of the ternary operator for better readability.

come-nc

When testing this branch (which will need a rebase after #52793 is merged), I do not see the ajax routes of user_ldap in the output of occ router:list.
So either the command is missing them or you broke their loading in the router.
And I do not see anything special in the command code, apart from the wrong assumption that all routes have a caller default.

susnux · 2025-06-05T19:29:53Z

And I do not see anything special in the command code, apart from the wrong assumption that all routes have a caller default.

It is set by the parser?

server/lib/private/AppFramework/Routing/RouteParser.php

Line 112 in b8b229c

$defaults['caller'] = [$appName, $controllerName, $actionName];

- Add routes to individual collections for each app and then merge them for the root collection holding all routes for the URL generator. - Short cut route loading with already loaded apps - Simplify active collection handling - Remove deprecated `OC_App` usage - Fully type Router methods Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

susnux · 2025-06-05T19:53:09Z

So either the command is missing them or you broke their loading in the router.

Yes TBH thought we removed all places not returning an array from routes.php in #42678 but seems like I missed that we still have the IRouter (deprecated since 9!) that exposes the create method.

Probably revert this here :)

come-nc · 2025-06-10T07:42:41Z

Yeah, I had the issue with the cached routes PR, there are still routes returned by routes.php and relying on a file include.
Also there is the possibility to use a callable, but I did not find any use of that.

Yes IRouter::create is deprecated, but as it’s not obvious that it’s what is used in routes.php tooling will not warn application developpers about it.

Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

come-nc · 2025-06-10T08:40:23Z

With the tiny fix I pushed, it now works for old school routes:

$ occ router:list user_ldap
+-----------+-------------------------+------------------------------+--------+-----------------------------------------------------+----------------------------------------------------------+--------------+
| app | controller | function | method | path | defaults | requirements |
+-----------+-------------------------+------------------------------+--------+-----------------------------------------------------+----------------------------------------------------------+--------------+
| | | | | /apps/user_ldap/ajax/clearMappings.php | {"file":"user_ldap\/ajax\/clearMappings.php"} | |
| | | | | /apps/user_ldap/ajax/deleteConfiguration.php | {"file":"user_ldap\/ajax\/deleteConfiguration.php"} | |
| | | | | /apps/user_ldap/ajax/getConfiguration.php | {"file":"user_ldap\/ajax\/getConfiguration.php"} | |
| | | | | /apps/user_ldap/ajax/getNewServerConfigPrefix.php | {"file":"user_ldap\/ajax\/getNewServerConfigPrefix.php"} | |
| | | | | /apps/user_ldap/ajax/setConfiguration.php | {"file":"user_ldap\/ajax\/setConfiguration.php"} | |
| | | | | /apps/user_ldap/ajax/testConfiguration.php | {"file":"user_ldap\/ajax\/testConfiguration.php"} | |
| | | | | /apps/user_ldap/ajax/wizard.php | {"file":"user_ldap\/ajax\/wizard.php"} | |
| user_ldap | RenewPasswordController | tryRenewPassword | POST | /apps/user_ldap/renewpassword | | |
| user_ldap | RenewPasswordController | showRenewPasswordForm | GET | /apps/user_ldap/renewpassword/{user} | | |
| user_ldap | RenewPasswordController | cancel | GET | /apps/user_ldap/renewpassword/cancel | | |
| user_ldap | RenewPasswordController | showLoginFormInvalidPassword | GET | /apps/user_ldap/renewpassword/invalidlogin/{user} | | |
| user_ldap | ConfigAPIController | getConfig | GET | /ocs/v2.php/ocs/v2.php/config | | |
| user_ldap | ConfigAPIController | getCapabilities | GET | /ocs/v2.php/ocs/v2.php/cloud/capabilities | | |
| user_ldap | ConfigAPIController | personCheck | POST | /ocs/v2.php/ocs/v2.php/person/check | | |
| user_ldap | ConfigAPIController | getIdentityProof | GET | /ocs/v2.php/ocs/v2.php/identityproof/key/{cloudId} | | |
| user_ldap | ConfigAPIController | create | POST | /ocs/v2.php/apps/user_ldap/api/v1/config | | |
| user_ldap | ConfigAPIController | show | GET | /ocs/v2.php/apps/user_ldap/api/v1/config/{configID} | | |
| user_ldap | ConfigAPIController | modify | PUT | /ocs/v2.php/apps/user_ldap/api/v1/config/{configID} | | |
| user_ldap | ConfigAPIController | delete | DELETE | /ocs/v2.php/apps/user_ldap/api/v1/config/{configID} | | |
+-----------+-------------------------+------------------------------+--------+-----------------------------------------------------+----------------------------------------------------------+--------------+

The main weird thing is the empty application. It should just use the application id it nows about.

kesselb · 2025-06-25T08:41:59Z

A command, to list routes, was added by: #53669

What about the fix for the router?

susnux · 2026-01-14T13:58:35Z

#53669

susnux added this to the Nextcloud 32 milestone May 16, 2025

susnux added enhancement 2. developing Work in progress labels May 16, 2025

susnux force-pushed the feat/router-list-routs-cmd branch from 1886595 to 6669894Compare May 17, 2025 10:16

kesselb reviewed May 17, 2025
View reviewed changes

come-nc reviewed Jun 5, 2025
View reviewed changes

susnux added 4 commits June 5, 2025 21:45

feat: add command to list all routes registered
4c74911
Signed-off-by: Ferdinand Thiessen <opensource@fthiessen.de>

fixup! fix(Router): correctly add routes to separate collections
14653ef

fixup! fixup! fix(Router): correctly add routes to separate collections
129983f

susnux force-pushed the feat/router-list-routs-cmd branch from 4f41e49 to 129983fCompare June 5, 2025 19:51

fix(router): Fix loading legacy routes in the correct collection
0eabd9f
Signed-off-by: Côme Chilliet <come.chilliet@nextcloud.com>

skjnldsv modified the milestones: Nextcloud 32, Nextcloud 33 Sep 28, 2025

susnux closed this Jan 14, 2026

kesselb deleted the feat/router-list-routs-cmd branch January 14, 2026 14:08

Navigation Menu

Uh oh!

Uh oh!

feat: add OCC command to list all routes (incl. fixing the Router) - #52919

feat: add OCC command to list all routes (incl. fixing the Router)#52919
susnux wants to merge 5 commits into
masterfrom
feat/router-list-routs-cmd

susnux commented May 16, 2025

Uh oh!

kesselbMay 17, 2025

Uh oh!

kesselbMay 17, 2025

Uh oh!

kesselbMay 17, 2025

Uh oh!

come-nc left a comment

Uh oh!

susnux commented Jun 5, 2025

Uh oh!

susnux commented Jun 5, 2025

Uh oh!

come-nc commented Jun 10, 2025

Uh oh!

come-nc commented Jun 10, 2025

Uh oh!

kesselb commented Jun 25, 2025

Uh oh!

susnux commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

-$apps = $user === null
- ? $this->appManager->getEnabledApps()
- : $this->appManager->getEnabledAppsForUser($user);
+if ($user === null) {
+$apps = $this->appManager->getEnabledApps();
+ } else {
+$apps = $this->appManager->getEnabledAppsForUser($user);
+ }

Uh oh!

Uh oh!

Conversation

susnux commented May 16, 2025

Summary

Checklist

Uh oh!

kesselbMay 17, 2025

Choose a reason for hiding this comment

Uh oh!

kesselbMay 17, 2025

Choose a reason for hiding this comment

Uh oh!

kesselbMay 17, 2025

Choose a reason for hiding this comment

Uh oh!

come-nc left a comment

Choose a reason for hiding this comment

Uh oh!

susnux commented Jun 5, 2025

Uh oh!

susnux commented Jun 5, 2025

Uh oh!

come-nc commented Jun 10, 2025

Uh oh!

come-nc commented Jun 10, 2025

Uh oh!

kesselb commented Jun 25, 2025

Uh oh!

susnux commented Jan 14, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants