3 namespace Friendica\App;
6 use FastRoute\DataGenerator\GroupCountBased;
7 use FastRoute\Dispatcher;
8 use FastRoute\RouteCollector;
9 use FastRoute\RouteParser\Std;
13 * Wrapper for FastRoute\Router
15 * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
18 * Actual routes are defined in App->collectRoutes.
20 * @package Friendica\App
24 /** @var RouteCollector */
25 protected $routeCollector;
28 * Static declaration of Friendica routes.
34 * - HTTP method other than GET
37 * Handler must be the name of a class extending Friendica\BaseModule.
39 * @brief Static declaration of Friendica routes.
41 public function collectRoutes()
43 $this->routeCollector->addRoute(['GET'], '[/]', Module\Home::class);
44 $this->routeCollector->addGroup('/.well-known', function (RouteCollector $collector) {
45 $collector->addRoute(['GET'], '/host-meta' , Module\WellKnown\HostMeta::class);
46 $collector->addRoute(['GET'], '/nodeinfo[/1.0]' , Module\NodeInfo::class);
47 $collector->addRoute(['GET'], '/webfinger' , Module\Xrd::class);
48 $collector->addRoute(['GET'], '/x-social-relay' , Module\WellKnown\XSocialRelay::class);
50 $this->routeCollector->addGroup('/2fa', function (RouteCollector $collector) {
51 $collector->addRoute(['GET', 'POST'], '[/]' , Module\TwoFactor\Verify::class);
52 $collector->addRoute(['GET', 'POST'], '/recovery' , Module\TwoFactor\Recovery::class);
54 $this->routeCollector->addGroup('/admin', function (RouteCollector $collector) {
55 $collector->addRoute(['GET'] , '[/]' , Module\Admin\Summary::class);
57 $collector->addRoute(['GET', 'POST'], '/addons' , Module\Admin\Addons\Index::class);
58 $collector->addRoute(['GET', 'POST'], '/addons/{addon}' , Module\Admin\Addons\Details::class);
60 $collector->addRoute(['GET', 'POST'], '/blocklist/contact' , Module\Admin\Blocklist\Contact::class);
61 $collector->addRoute(['GET', 'POST'], '/blocklist/server' , Module\Admin\Blocklist\Server::class);
63 $collector->addRoute(['GET'] , '/dbsync[/check]' , Module\Admin\DBSync::class);
64 $collector->addRoute(['GET'] , '/dbsync/{update:\d+}' , Module\Admin\DBSync::class);
65 $collector->addRoute(['GET'] , '/dbsync/mark/{update:\d+}', Module\Admin\DBSync::class);
67 $collector->addRoute(['GET', 'POST'], '/features' , Module\Admin\Features::class);
68 $collector->addRoute(['GET'] , '/federation' , Module\Admin\Federation::class);
70 $collector->addRoute(['GET', 'POST'], '/item/delete' , Module\Admin\Item\Delete::class);
71 $collector->addRoute(['GET', 'POST'], '/item/source[/{guid}]' , Module\Admin\Item\Source::class);
73 $collector->addRoute(['GET'] , '/logs/view' , Module\Admin\Logs\View::class);
74 $collector->addRoute(['GET', 'POST'], '/logs' , Module\Admin\Logs\Settings::class);
76 $collector->addRoute(['GET'] , '/phpinfo' , Module\Admin\PhpInfo::class);
78 $collector->addRoute(['GET'] , '/queue[/deferred]' , Module\Admin\Queue::class);
80 $collector->addRoute(['GET', 'POST'], '/site' , Module\Admin\Site::class);
82 $collector->addRoute(['GET', 'POST'], '/themes' , Module\Admin\Themes\Index::class);
83 $collector->addRoute(['GET', 'POST'], '/themes/{theme}' , Module\Admin\Themes\Details::class);
84 $collector->addRoute(['GET', 'POST'], '/themes/{theme}/embed' , Module\Admin\Themes\Embed::class);
86 $collector->addRoute(['GET', 'POST'], '/tos' , Module\Admin\Tos::class);
88 $collector->addRoute(['GET', 'POST'], '/users[/{action}/{uid}]' , Module\Admin\Users::class);
90 $this->routeCollector->addRoute(['GET'], '/amcd', Module\AccountManagementControlDocument::class);
91 $this->routeCollector->addRoute(['GET'], '/acctlink', Module\Acctlink::class);
92 $this->routeCollector->addRoute(['GET'], '/allfriends/{id:\d+}', Module\AllFriends::class);
93 $this->routeCollector->addRoute(['GET'], '/apps', Module\Apps::class);
94 $this->routeCollector->addRoute(['GET'], '/attach/{item:\d+}', Module\Attach::class);
95 $this->routeCollector->addRoute(['GET'], '/babel', Module\Babel::class);
96 $this->routeCollector->addRoute(['GET'], '/bookmarklet', Module\Bookmarklet::class);
97 $this->routeCollector->addGroup('/contact', function (RouteCollector $collector) {
98 $collector->addRoute(['GET'], '[/]', Module\Contact::class);
99 $collector->addRoute(['GET', 'POST'], '/{id:\d+}[/]', Module\Contact::class);
100 $collector->addRoute(['GET'], '/{id:\d+}/archive', Module\Contact::class);
101 $collector->addRoute(['GET'], '/{id:\d+}/block', Module\Contact::class);
102 $collector->addRoute(['GET'], '/{id:\d+}/conversations', Module\Contact::class);
103 $collector->addRoute(['GET'], '/{id:\d+}/drop', Module\Contact::class);
104 $collector->addRoute(['GET'], '/{id:\d+}/ignore', Module\Contact::class);
105 $collector->addRoute(['GET'], '/{id:\d+}/posts', Module\Contact::class);
106 $collector->addRoute(['GET'], '/{id:\d+}/update', Module\Contact::class);
107 $collector->addRoute(['GET'], '/{id:\d+}/updateprofile', Module\Contact::class);
108 $collector->addRoute(['GET'], '/all', Module\Contact::class);
109 $collector->addRoute(['GET'], '/archived', Module\Contact::class);
110 $collector->addRoute(['GET', 'POST'], '/batch', Module\Contact::class);
111 $collector->addRoute(['GET'], '/blocked', Module\Contact::class);
112 $collector->addRoute(['GET'], '/hidden', Module\Contact::class);
113 $collector->addRoute(['GET'], '/ignored', Module\Contact::class);
115 $this->routeCollector->addRoute(['GET'], '/credits', Module\Credits::class);
116 $this->routeCollector->addRoute(['GET'], '/directory', Module\Directory::class);
117 $this->routeCollector->addGroup('/feed', function (RouteCollector $collector) {
118 $collector->addRoute(['GET'], '/{nickname}', Module\Feed::class);
119 $collector->addRoute(['GET'], '/{nickname}/posts', Module\Feed::class);
120 $collector->addRoute(['GET'], '/{nickname}/comments', Module\Feed::class);
121 $collector->addRoute(['GET'], '/{nickname}/replies', Module\Feed::class);
122 $collector->addRoute(['GET'], '/{nickname}/activity', Module\Feed::class);
124 $this->routeCollector->addRoute(['GET'], '/feedtest', Module\Feedtest::class);
125 $this->routeCollector->addGroup('/fetch', function (RouteCollector $collector) {
126 $collector->addRoute(['GET'], '/{guid}/post', Module\Diaspora\Fetch::class);
127 $collector->addRoute(['GET'], '/{guid}/status_message', Module\Diaspora\Fetch::class);
128 $collector->addRoute(['GET'], '/{guid}/reshare', Module\Diaspora\Fetch::class);
130 $this->routeCollector->addRoute(['GET'], '/filer[/{id:\d+}]', Module\Filer\SaveTag::class);
131 $this->routeCollector->addRoute(['GET'], '/filerm/{id:\d+}', Module\Filer\RemoveTag::class);
132 $this->routeCollector->addRoute(['GET', 'POST'], '/follow_confirm', Module\FollowConfirm::class);
133 $this->routeCollector->addRoute(['GET'], '/followers/{owner}', Module\Followers::class);
134 $this->routeCollector->addRoute(['GET'], '/following/{owner}', Module\Following::class);
135 $this->routeCollector->addRoute(['GET'], '/friendica[/json]', Module\Friendica::class);
136 $this->routeCollector->addGroup('/group', function (RouteCollector $collector) {
137 $collector->addRoute(['GET', 'POST'], '[/]', Module\Group::class);
138 $collector->addRoute(['GET', 'POST'], '/{group:\d+}', Module\Group::class);
139 $collector->addRoute(['GET', 'POST'], '/none', Module\Group::class);
140 $collector->addRoute(['GET', 'POST'], '/new', Module\Group::class);
141 $collector->addRoute(['GET', 'POST'], '/drop/{group:\d+}', Module\Group::class);
142 $collector->addRoute(['GET', 'POST'], '/{group:\d+}/{contact:\d+}', Module\Group::class);
144 $collector->addRoute(['GET', 'POST'], '/{group:\d+}/add/{contact:\d+}', Module\Group::class);
145 $collector->addRoute(['GET', 'POST'], '/{group:\d+}/remove/{contact:\d+}', Module\Group::class);
147 $this->routeCollector->addRoute(['GET'], '/hashtag', Module\Hashtag::class);
148 $this->routeCollector->addRoute(['GET'], '/home', Module\Home::class);
149 $this->routeCollector->addRoute(['GET'], '/help[/{doc:.+}]', Module\Help::class);
150 $this->routeCollector->addRoute(['GET'], '/inbox[/{nickname}]', Module\Inbox::class);
151 $this->routeCollector->addRoute(['GET', 'POST'], '/invite', Module\Invite::class);
152 $this->routeCollector->addGroup('/install', function (RouteCollector $collector) {
153 $collector->addRoute(['GET', 'POST'], '[/]', Module\Install::class);
154 $collector->addRoute(['GET'], '/testrewrite', Module\Install::class);
156 $this->routeCollector->addRoute(['GET', 'POST'], '/itemsource[/{guid}]', Module\Itemsource::class);
157 $this->routeCollector->addRoute(['GET'], '/like/{item:\d+}', Module\Like::class);
158 $this->routeCollector->addRoute(['GET', 'POST'], '/localtime', Module\Localtime::class);
159 $this->routeCollector->addRoute(['GET', 'POST'], '/login', Module\Login::class);
160 $this->routeCollector->addRoute(['GET', 'POST'], '/logout', Module\Logout::class);
161 $this->routeCollector->addRoute(['GET'], '/magic', Module\Magic::class);
162 $this->routeCollector->addRoute(['GET'], '/maintenance', Module\Maintenance::class);
163 $this->routeCollector->addRoute(['GET'], '/manifest', Module\Manifest::class);
164 $this->routeCollector->addRoute(['GET'], '/modexp/{nick}', Module\PublicRSAKey::class);
165 $this->routeCollector->addRoute(['GET'], '/nodeinfo/1.0', Module\NodeInfo::class);
166 $this->routeCollector->addRoute(['GET'], '/nogroup', Module\Group::class);
167 $this->routeCollector->addRoute(['GET'], '/objects/{guid}', Module\Objects::class);
168 $this->routeCollector->addGroup('/oembed', function (RouteCollector $collector) {
169 $collector->addRoute(['GET'], '/b2h', Module\Oembed::class);
170 $collector->addRoute(['GET'], '/h2b', Module\Oembed::class);
171 $collector->addRoute(['GET'], '/{hash}', Module\Oembed::class);
173 $this->routeCollector->addRoute(['GET'], '/outbox/{owner}', Module\Outbox::class);
174 $this->routeCollector->addRoute(['GET'], '/owa', Module\Owa::class);
175 $this->routeCollector->addGroup('/photo', function (RouteCollector $collector) {
176 $collector->addRoute(['GET'], '/{name}', Module\Photo::class);
177 $collector->addRoute(['GET'], '/{type}/{name}', Module\Photo::class);
178 $collector->addRoute(['GET'], '/{type}/{customize}/{name}', Module\Photo::class);
180 $this->routeCollector->addRoute(['GET'], '/pretheme', Module\ThemeDetails::class);
181 $this->routeCollector->addGroup('/profile', function (RouteCollector $collector) {
182 $collector->addRoute(['GET'], '/{nickname}', Module\Profile::class);
183 $collector->addRoute(['GET'], '/{profile:\d+}/view', Module\Profile::class);
185 $this->routeCollector->addGroup('/proxy', function (RouteCollector $collector) {
186 $collector->addRoute(['GET'], '[/]' , Module\Proxy::class);
187 $collector->addRoute(['GET'], '/{url}' , Module\Proxy::class);
188 $collector->addRoute(['GET'], '/{sub1}/{url}' , Module\Proxy::class);
189 $collector->addRoute(['GET'], '/{sub1}/{sub2}/{url}' , Module\Proxy::class);
192 $this->routeCollector->addGroup('/settings', function (RouteCollector $collector) {
193 $collector->addGroup('/2fa', function (RouteCollector $collector) {
194 $collector->addRoute(['GET', 'POST'], '[/]' , Module\Settings\TwoFactor\Index::class);
195 $collector->addRoute(['GET', 'POST'], '/recovery' , Module\Settings\TwoFactor\Recovery::class);
196 $collector->addRoute(['GET', 'POST'], '/verify' , Module\Settings\TwoFactor\Verify::class);
199 $this->routeCollector->addRoute(['GET', 'POST'], '/register', Module\Register::class);
200 $this->routeCollector->addRoute(['GET'], '/robots.txt', Module\RobotsTxt::class);
201 $this->routeCollector->addRoute(['GET'], '/rsd.xml', Module\ReallySimpleDiscovery::class);
202 $this->routeCollector->addRoute(['GET'], '/smilies[/json]', Module\Smilies::class);
203 $this->routeCollector->addRoute(['GET'], '/statistics.json', Module\Statistics::class);
204 $this->routeCollector->addRoute(['GET'], '/tos', Module\Tos::class);
205 $this->routeCollector->addRoute(['GET'], '/viewsrc/{item:\d+}', Module\ItemBody::class);
206 $this->routeCollector->addRoute(['GET'], '/webfinger', Module\WebFinger::class);
207 $this->routeCollector->addRoute(['GET'], '/xrd', Module\Xrd::class);
210 public function __construct(RouteCollector $routeCollector = null)
212 if (!$routeCollector) {
213 $routeCollector = new RouteCollector(new Std(), new GroupCountBased());
216 $this->routeCollector = $routeCollector;
219 public function getRouteCollector()
221 return $this->routeCollector;
225 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
227 * @param string $cmd The path component of the request URL without the query string
228 * @return string|null A Friendica\BaseModule-extending class name if a route rule matched
230 public function getModuleClass($cmd)
232 $cmd = '/' . ltrim($cmd, '/');
234 $dispatcher = new \FastRoute\Dispatcher\GroupCountBased($this->routeCollector->getData());
238 // @TODO: Enable method-specific modules
240 $routeInfo = $dispatcher->dispatch($httpMethod, $cmd);
241 if ($routeInfo[0] === Dispatcher::FOUND) {
242 $moduleClass = $routeInfo[1];