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