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', 'POST'], '/itemsource[/{guid}]', Module\Itemsource::class);
44 $this->routeCollector->addRoute(['GET'], '/amcd', Module\AccountManagementControlDocument::class);
45 $this->routeCollector->addGroup('/.well-known', function (RouteCollector $collector) {
46 $collector->addRoute(['GET'], '/host-meta' , Module\WellKnown\HostMeta::class);
47 $collector->addRoute(['GET'], '/nodeinfo[/1.0]' , Module\NodeInfo::class);
48 $collector->addRoute(['GET'], '/webfinger' , Module\Xrd::class);
49 $collector->addRoute(['GET'], '/x-social-relay' , Module\WellKnown\XSocialRelay::class);
51 $this->routeCollector->addRoute(['GET'], '/acctlink', Module\Acctlink::class);
52 $this->routeCollector->addRoute(['GET'], '/apps', Module\Apps::class);
53 $this->routeCollector->addRoute(['GET'], '/attach/{item:\d+}', Module\Attach::class);
54 $this->routeCollector->addRoute(['GET'], '/babel', Module\Babel::class);
55 $this->routeCollector->addGroup('/contact', function (RouteCollector $collector) {
56 $collector->addRoute(['GET'], '[/]', Module\Contact::class);
57 $collector->addRoute(['GET'], '/{id:\d+}[/posts|conversations]', Module\Contact::class);
59 $this->routeCollector->addRoute(['GET'], '/credits', Module\Credits::class);
60 $this->routeCollector->addGroup('/feed', function (RouteCollector $collector) {
61 $collector->addRoute(['GET'], '/{nickname}', Module\Feed::class);
62 $collector->addRoute(['GET'], '/{nickname}/posts', Module\Feed::class);
63 $collector->addRoute(['GET'], '/{nickname}/comments', Module\Feed::class);
64 $collector->addRoute(['GET'], '/{nickname}/replies', Module\Feed::class);
65 $collector->addRoute(['GET'], '/{nickname}/activity', Module\Feed::class);
67 $this->routeCollector->addRoute(['GET'], '/feedtest', Module\Feedtest::class);
68 $this->routeCollector->addRoute(['GET'], '/filer[/{id:\d+}]', Module\Filer::class);
69 $this->routeCollector->addRoute(['GET'], '/followers/{owner}', Module\Followers::class);
70 $this->routeCollector->addRoute(['GET'], '/following/{owner}', Module\Following::class);
71 $this->routeCollector->addGroup('/group', function (RouteCollector $collector) {
72 $collector->addRoute(['GET', 'POST'], '[/]', Module\Group::class);
73 $collector->addRoute(['GET', 'POST'], '/{group:\d+}', Module\Group::class);
74 $collector->addRoute(['GET', 'POST'], '/none', Module\Group::class);
75 $collector->addRoute(['GET', 'POST'], '/new', Module\Group::class);
76 $collector->addRoute(['GET', 'POST'], '/drop/{group:\d+}', Module\Group::class);
77 $collector->addRoute(['GET', 'POST'], '/{group:\d+}/{contact:\d+}', Module\Group::class);
79 $collector->addRoute(['POST'], '/{group:\d+}/add/{contact:\d+}', Module\Group::class);
80 $collector->addRoute(['POST'], '/{group:\d+}/remove/{contact:\d+}', Module\Group::class);
82 $this->routeCollector->addRoute(['GET'], '/hashtag', Module\Hashtag::class);
83 $this->routeCollector->addRoute(['GET'], '/inbox[/{nickname}]', Module\Inbox::class);
84 $this->routeCollector->addGroup('/install', function (RouteCollector $collector) {
85 $collector->addRoute(['GET', 'POST'], '[/]', Module\Install::class);
86 $collector->addRoute(['GET'], '/testrewrite', Module\Install::class);
88 $this->routeCollector->addRoute(['GET', 'POST'], '/localtime', Module\Localtime::class);
89 $this->routeCollector->addRoute(['GET', 'POST'], '/login', Module\Login::class);
90 $this->routeCollector->addRoute(['GET'], '/magic', Module\Magic::class);
91 $this->routeCollector->addRoute(['GET'], '/manifest', Module\Manifest::class);
92 $this->routeCollector->addRoute(['GET'], '/nodeinfo/1.0', Module\NodeInfo::class);
93 $this->routeCollector->addRoute(['GET'], '/objects/{guid}', Module\Objects::class);
94 $this->routeCollector->addGroup('/oembed', function (RouteCollector $collector) {
95 $collector->addRoute(['GET'], '/[b2h|h2b]', Module\Oembed::class);
96 $collector->addRoute(['GET'], '/{hash}', Module\Oembed::class);
98 $this->routeCollector->addRoute(['GET'], '/outbox/{owner}', Module\Outbox::class);
99 $this->routeCollector->addRoute(['GET'], '/owa', Module\Owa::class);
100 $this->routeCollector->addGroup('/photo', function (RouteCollector $collector) {
101 $collector->addRoute(['GET'], '/{name}', Module\Photo::class);
102 $collector->addRoute(['GET'], '/{type}/{name}', Module\Photo::class);
103 $collector->addRoute(['GET'], '/{type}/{customize}/{name}', Module\Photo::class);
105 $this->routeCollector->addGroup('/profile', function (RouteCollector $collector) {
106 $collector->addRoute(['GET'], '/{nickname}', Module\Profile::class);
107 $collector->addRoute(['GET'], '/{profile:\d+}/view', Module\Profile::class);
109 $this->routeCollector->addGroup('/proxy', function (RouteCollector $collector) {
110 $collector->addRoute(['GET'], '[/]', Module\Proxy::class);
111 $collector->addRoute(['GET'], '/{url}', Module\Proxy::class);
112 $collector->addRoute(['GET'], '/sub1/{url}', Module\Proxy::class);
113 $collector->addRoute(['GET'], '/sub1/sub2/{url}', Module\Proxy::class);
115 $this->routeCollector->addRoute(['GET', 'POST'], '/register', Module\Register::class);
116 $this->routeCollector->addRoute(['GET'], '/statistics.json', Module\Statistics::class);
117 $this->routeCollector->addRoute(['GET'], '/tos', Module\Tos::class);
118 $this->routeCollector->addRoute(['GET'], '/webfinger', Module\WebFinger::class);
119 $this->routeCollector->addRoute(['GET'], '/xrd', Module\Xrd::class);
121 $this->routeCollector->addGroup('/admin', function (RouteCollector $collector) {
122 $collector->addRoute(['GET'] , '[/]' , Module\Admin\Summary::class);
124 $collector->addRoute(['GET', 'POST'], '/addons' , Module\Admin\Addons\Index::class);
125 $collector->addRoute(['GET', 'POST'], '/addons/{addon}' , Module\Admin\Addons\Details::class);
127 $collector->addRoute(['GET', 'POST'], '/blocklist/contact' , Module\Admin\Blocklist\Contact::class);
128 $collector->addRoute(['GET', 'POST'], '/blocklist/server' , Module\Admin\Blocklist\Server::class);
130 $collector->addRoute(['GET', 'POST'], '/features' , Module\Admin\Features::class);
131 $collector->addRoute(['GET'] , '/federation' , Module\Admin\Federation::class);
133 $collector->addRoute(['GET'] , '/queue[/deferred]' , Module\Admin\Queue::class);
135 $collector->addRoute(['GET', 'POST'], '/site' , Module\Admin\Site::class);
137 $collector->addRoute(['GET', 'POST'], '/themes' , Module\Admin\Themes\Index::class);
138 $collector->addRoute(['GET', 'POST'], '/themes/{theme}' , Module\Admin\Themes\Details::class);
139 $collector->addRoute(['GET', 'POST'], '/themes/{theme}/embed' , Module\Admin\Themes\Embed::class);
141 $collector->addRoute(['GET', 'POST'], '/tos' , Module\Admin\Tos::class);
143 $collector->addRoute(['GET', 'POST'], '/users[/{action}/{uid}]' , Module\Admin\Users::class);
147 public function __construct(RouteCollector $routeCollector = null)
149 if (!$routeCollector) {
150 $routeCollector = new RouteCollector(new Std(), new GroupCountBased());
153 $this->routeCollector = $routeCollector;
156 public function getRouteCollector()
158 return $this->routeCollector;
162 * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
164 * @param string $cmd The path component of the request URL without the query string
165 * @return string|null A Friendica\BaseModule-extending class name if a route rule matched
167 public function getModuleClass($cmd)
169 $cmd = '/' . ltrim($cmd, '/');
171 $dispatcher = new \FastRoute\Dispatcher\GroupCountBased($this->routeCollector->getData());
175 // @TODO: Enable method-specific modules
177 $routeInfo = $dispatcher->dispatch($httpMethod, $cmd);
178 if ($routeInfo[0] === Dispatcher::FOUND) {
179 $moduleClass = $routeInfo[1];