src/App/Router.php

   1 <?php
   2
   3 namespace Friendica\App;
   4
   5
   6 use FastRoute\DataGenerator\GroupCountBased;
   7 use FastRoute\Dispatcher;
   8 use FastRoute\RouteCollector;
   9 use FastRoute\RouteParser\Std;
  10 use Friendica\Module;
  11
  12 /**
  13  * Wrapper for FastRoute\Router
  14  *
  15  * This wrapper only makes use of a subset of the router features, mainly parses a route rule to return the relevant
  16  * module class.
  17  *
  18  * Actual routes are defined in App->collectRoutes.
  19  *
  20  * @package Friendica\App
  21  */
  22 class Router
  23 {
  24         /** @var RouteCollector */
  25         protected $routeCollector;
  26
  27         /**
  28          * Static declaration of Friendica routes.
  29          *
  30          * Supports:
  31          * - Route groups
  32          * - Variable parts
  33          * Disregards:
  34          * - HTTP method other than GET
  35          * - Named parameters
  36          *
  37          * Handler must be the name of a class extending Friendica\BaseModule.
  38          *
  39          * @brief Static declaration of Friendica routes.
  40          */
  41         public function collectRoutes()
  42         {
  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);
  49                 });
  50                 $this->routeCollector->addGroup('/admin', function (RouteCollector $collector) {
  51                         $collector->addRoute(['GET']        , '[/]'                     , Module\Admin\Summary::class);
  52
  53                         $collector->addRoute(['GET', 'POST'], '/addons'                 , Module\Admin\Addons\Index::class);
  54                         $collector->addRoute(['GET', 'POST'], '/addons/{addon}'         , Module\Admin\Addons\Details::class);
  55
  56                         $collector->addRoute(['GET', 'POST'], '/blocklist/contact'      , Module\Admin\Blocklist\Contact::class);
  57                         $collector->addRoute(['GET', 'POST'], '/blocklist/server'       , Module\Admin\Blocklist\Server::class);
  58
  59                         $collector->addRoute(['GET']        , '/dbsync[/check]'         , Module\Admin\DBSync::class);
  60                         $collector->addRoute(['GET']        , '/dbsync/{update:\d+}'    , Module\Admin\DBSync::class);
  61                         $collector->addRoute(['GET']        , '/dbsync/mark/{update:\d+}', Module\Admin\DBSync::class);
  62
  63                         $collector->addRoute(['GET', 'POST'], '/features'               , Module\Admin\Features::class);
  64                         $collector->addRoute(['GET']        , '/federation'             , Module\Admin\Federation::class);
  65
  66                         $collector->addRoute(['GET', 'POST'], '/item/delete'            , Module\Admin\Item\Delete::class);
  67                         $collector->addRoute(['GET', 'POST'], '/item/source[/{guid}]'   , Module\Admin\Item\Source::class);
  68
  69                         $collector->addRoute(['GET']        , '/logs/view'              , Module\Admin\Logs\View::class);
  70                         $collector->addRoute(['GET', 'POST'], '/logs'                   , Module\Admin\Logs\Settings::class);
  71
  72                         $collector->addRoute(['GET']        , '/phpinfo'                , Module\Admin\PhpInfo::class);
  73
  74                         $collector->addRoute(['GET']        , '/queue[/deferred]'       , Module\Admin\Queue::class);
  75
  76                         $collector->addRoute(['GET', 'POST'], '/site'                   , Module\Admin\Site::class);
  77
  78                         $collector->addRoute(['GET', 'POST'], '/themes'                 , Module\Admin\Themes\Index::class);
  79                         $collector->addRoute(['GET', 'POST'], '/themes/{theme}'         , Module\Admin\Themes\Details::class);
  80                         $collector->addRoute(['GET', 'POST'], '/themes/{theme}/embed'   , Module\Admin\Themes\Embed::class);
  81
  82                         $collector->addRoute(['GET', 'POST'], '/tos'                    , Module\Admin\Tos::class);
  83
  84                         $collector->addRoute(['GET', 'POST'], '/users[/{action}/{uid}]' , Module\Admin\Users::class);
  85                 });
  86                 $this->routeCollector->addRoute(['GET'],         '/amcd',                Module\AccountManagementControlDocument::class);
  87                 $this->routeCollector->addRoute(['GET'],         '/acctlink',            Module\Acctlink::class);
  88                 $this->routeCollector->addRoute(['GET'],         '/allfriends/{id:\d+}', Module\AllFriends::class);
  89                 $this->routeCollector->addRoute(['GET'],         '/apps',                Module\Apps::class);
  90                 $this->routeCollector->addRoute(['GET'],         '/attach/{item:\d+}',   Module\Attach::class);
  91                 $this->routeCollector->addRoute(['GET'],         '/babel',               Module\Babel::class);
  92                 $this->routeCollector->addRoute(['GET'],         '/bookmarklet',         Module\Bookmarklet::class);
  93                 $this->routeCollector->addGroup('/contact', function (RouteCollector $collector) {
  94                         $collector->addRoute(['GET'], '[/]',                                 Module\Contact::class);
  95                         $collector->addRoute(['GET'], '/{id:\d+}[/posts|conversations]',     Module\Contact::class);
  96                 });
  97                 $this->routeCollector->addRoute(['GET'],         '/credits',             Module\Credits::class);
  98                 $this->routeCollector->addRoute(['GET'],         '/directory',           Module\Directory::class);
  99                 $this->routeCollector->addGroup('/feed', function (RouteCollector $collector) {
 100                         $collector->addRoute(['GET'], '/{nickname}',                         Module\Feed::class);
 101                         $collector->addRoute(['GET'], '/{nickname}/posts',                   Module\Feed::class);
 102                         $collector->addRoute(['GET'], '/{nickname}/comments',                Module\Feed::class);
 103                         $collector->addRoute(['GET'], '/{nickname}/replies',                 Module\Feed::class);
 104                         $collector->addRoute(['GET'], '/{nickname}/activity',                Module\Feed::class);
 105                 });
 106                 $this->routeCollector->addRoute(['GET'],         '/feedtest',            Module\Feedtest::class);
 107                 $this->routeCollector->addGroup('/fetch', function (RouteCollector $collector) {
 108                         $collector->addRoute(['GET'], '/{guid}/post',                        Module\Diaspora\Fetch::class);
 109                         $collector->addRoute(['GET'], '/{guid}/status_message',              Module\Diaspora\Fetch::class);
 110                         $collector->addRoute(['GET'], '/{guid}/reshare',                     Module\Diaspora\Fetch::class);
 111                 });
 112                 $this->routeCollector->addRoute(['GET'],         '/filer[/{id:\d+}]',    Module\Filer::class);
 113                 $this->routeCollector->addRoute(['GET'],         '/followers/{owner}',   Module\Followers::class);
 114                 $this->routeCollector->addRoute(['GET'],         '/following/{owner}',   Module\Following::class);
 115                 $this->routeCollector->addRoute(['GET'],         '/friendica[/json]',    Module\Friendica::class);
 116                 $this->routeCollector->addGroup('/group', function (RouteCollector $collector) {
 117                         $collector->addRoute(['GET', 'POST'], '[/]',                         Module\Group::class);
 118                         $collector->addRoute(['GET', 'POST'], '/{group:\d+}',                Module\Group::class);
 119                         $collector->addRoute(['GET', 'POST'], '/none',                       Module\Group::class);
 120                         $collector->addRoute(['GET', 'POST'], '/new',                        Module\Group::class);
 121                         $collector->addRoute(['GET', 'POST'], '/drop/{group:\d+}',           Module\Group::class);
 122                         $collector->addRoute(['GET', 'POST'], '/{group:\d+}/{contact:\d+}',  Module\Group::class);
 123
 124                         $collector->addRoute(['POST'], '/{group:\d+}/add/{contact:\d+}',     Module\Group::class);
 125                         $collector->addRoute(['POST'], '/{group:\d+}/remove/{contact:\d+}',  Module\Group::class);
 126                 });
 127                 $this->routeCollector->addRoute(['GET'],         '/hashtag',             Module\Hashtag::class);
 128                 $this->routeCollector->addRoute(['GET'],         '/home',                Module\Home::class);
 129                 $this->routeCollector->addRoute(['GET'],         '/help[/{doc:.+}]',     Module\Help::class);
 130                 $this->routeCollector->addRoute(['GET'],         '/inbox[/{nickname}]',  Module\Inbox::class);
 131                 $this->routeCollector->addRoute(['GET', 'POST'], '/invite',              Module\Invite::class);
 132                 $this->routeCollector->addGroup('/install', function (RouteCollector $collector) {
 133                         $collector->addRoute(['GET', 'POST'], '[/]',                         Module\Install::class);
 134                         $collector->addRoute(['GET'],         '/testrewrite',                Module\Install::class);
 135                 });
 136                 $this->routeCollector->addRoute(['GET', 'POST'], '/itemsource[/{guid}]', Module\Itemsource::class);
 137                 $this->routeCollector->addRoute(['GET'],         '/like/{item:\d+}',     Module\Like::class);
 138                 $this->routeCollector->addRoute(['GET', 'POST'], '/localtime',           Module\Localtime::class);
 139                 $this->routeCollector->addRoute(['GET', 'POST'], '/login',               Module\Login::class);
 140                 $this->routeCollector->addRoute(['GET', 'POST'], '/logout',              Module\Logout::class);
 141                 $this->routeCollector->addRoute(['GET'],         '/magic',               Module\Magic::class);
 142                 $this->routeCollector->addRoute(['GET'],         '/manifest',            Module\Manifest::class);
 143                 $this->routeCollector->addRoute(['GET'],         '/modexp/{nick}',       Module\PublicRSAKey::class);
 144                 $this->routeCollector->addRoute(['GET'],         '/nodeinfo/1.0',        Module\NodeInfo::class);
 145                 $this->routeCollector->addRoute(['GET'],         '/nogroup',             Module\Group::class);
 146                 $this->routeCollector->addRoute(['GET'],         '/objects/{guid}',      Module\Objects::class);
 147                 $this->routeCollector->addGroup('/oembed', function (RouteCollector $collector) {
 148                         $collector->addRoute(['GET'], '/[b2h|h2b]',                          Module\Oembed::class);
 149                         $collector->addRoute(['GET'], '/{hash}',                             Module\Oembed::class);
 150                 });
 151                 $this->routeCollector->addRoute(['GET'],         '/outbox/{owner}',      Module\Outbox::class);
 152                 $this->routeCollector->addRoute(['GET'],         '/owa',                 Module\Owa::class);
 153                 $this->routeCollector->addGroup('/photo', function (RouteCollector $collector) {
 154                         $collector->addRoute(['GET'], '/{name}',                             Module\Photo::class);
 155                         $collector->addRoute(['GET'], '/{type}/{name}',                      Module\Photo::class);
 156                         $collector->addRoute(['GET'], '/{type}/{customize}/{name}',          Module\Photo::class);
 157                 });
 158                 $this->routeCollector->addGroup('/profile', function (RouteCollector $collector) {
 159                         $collector->addRoute(['GET'], '/{nickname}',                         Module\Profile::class);
 160                         $collector->addRoute(['GET'], '/{profile:\d+}/view',                 Module\Profile::class);
 161                 });
 162                 $this->routeCollector->addGroup('/proxy', function (RouteCollector $collector) {
 163                         $collector->addRoute(['GET'], '[/]'                                , Module\Proxy::class);
 164                         $collector->addRoute(['GET'], '/{url}'                             , Module\Proxy::class);
 165                         $collector->addRoute(['GET'], '/{sub1}/{url}'                      , Module\Proxy::class);
 166                         $collector->addRoute(['GET'], '/{sub1}/{sub2}/{url}'               , Module\Proxy::class);
 167                 });
 168                 $this->routeCollector->addRoute(['GET', 'POST'], '/register',            Module\Register::class);
 169                 $this->routeCollector->addRoute(['GET'],         '/robots.txt',          Module\RobotsTxt::class);
 170                 $this->routeCollector->addRoute(['GET'],         '/rsd.xml',             Module\ReallySimpleDiscovery::class);
 171                 $this->routeCollector->addRoute(['GET'],         '/statistics.json',     Module\Statistics::class);
 172                 $this->routeCollector->addRoute(['GET'],         '/tos',                 Module\Tos::class);
 173                 $this->routeCollector->addRoute(['GET'],         '/webfinger',           Module\WebFinger::class);
 174                 $this->routeCollector->addRoute(['GET'],         '/xrd',                 Module\Xrd::class);
 175         }
 176
 177         public function __construct(RouteCollector $routeCollector = null)
 178         {
 179                 if (!$routeCollector) {
 180                         $routeCollector = new RouteCollector(new Std(), new GroupCountBased());
 181                 }
 182
 183                 $this->routeCollector = $routeCollector;
 184         }
 185
 186         public function getRouteCollector()
 187         {
 188                 return $this->routeCollector;
 189         }
 190
 191         /**
 192          * Returns the relevant module class name for the given page URI or NULL if no route rule matched.
 193          *
 194          * @param string $cmd The path component of the request URL without the query string
 195          * @return string|null A Friendica\BaseModule-extending class name if a route rule matched
 196          */
 197         public function getModuleClass($cmd)
 198         {
 199                 $cmd = '/' . ltrim($cmd, '/');
 200
 201                 $dispatcher = new \FastRoute\Dispatcher\GroupCountBased($this->routeCollector->getData());
 202
 203                 $moduleClass = null;
 204
 205                 // @TODO: Enable method-specific modules
 206                 $httpMethod = 'GET';
 207                 $routeInfo = $dispatcher->dispatch($httpMethod, $cmd);
 208                 if ($routeInfo[0] === Dispatcher::FOUND) {
 209                         $moduleClass = $routeInfo[1];
 210                 }
 211
 212                 return $moduleClass;
 213         }
 214 }