From 90248f6bb7227d0de15085a53bb6108f1e5a91ec Mon Sep 17 00:00:00 2001 From: Philipp Holzer Date: Wed, 1 May 2019 00:14:06 +0200 Subject: [PATCH] Move .well-known, webfinger, xrd to src/Module/ --- mod/_well_known.php | 82 -------- mod/webfinger.php | 42 ---- mod/xrd.php | 134 ------------ src/App/Router.php | 8 + src/Model/Search.php | 32 +++ src/Model/User.php | 16 +- src/Module/{Nodeinfo.php => NodeInfo.php} | 7 +- src/Module/WebFinger.php | 235 ++++++++++++++++++++++ src/Module/{ => WellKnown}/HostMeta.php | 15 +- src/Module/WellKnown/XSocialRelay.php | 62 ++++++ 10 files changed, 358 insertions(+), 275 deletions(-) delete mode 100644 mod/_well_known.php delete mode 100644 mod/webfinger.php delete mode 100644 mod/xrd.php create mode 100644 src/Model/Search.php rename src/Module/{Nodeinfo.php => NodeInfo.php} (95%) create mode 100644 src/Module/WebFinger.php rename src/Module/{ => WellKnown}/HostMeta.php (76%) create mode 100644 src/Module/WellKnown/XSocialRelay.php diff --git a/mod/_well_known.php b/mod/_well_known.php deleted file mode 100644 index 3bd86ecc9..000000000 --- a/mod/_well_known.php +++ /dev/null @@ -1,82 +0,0 @@ -argc > 1) { - switch ($a->argv[1]) { - case "host-meta": - HostMeta::printHostMeta(); - break; - case "x-social-relay": - wk_social_relay(); - break; - case "nodeinfo": - Nodeinfo::printWellKnown($a); - break; - case "webfinger": - xrd_init($a); - break; - } - } - System::httpExit(404); -} - -function wk_social_relay() -{ - $subscribe = (bool) Config::get('system', 'relay_subscribe', false); - - if ($subscribe) { - $scope = Config::get('system', 'relay_scope', SR_SCOPE_ALL); - } else { - $scope = SR_SCOPE_NONE; - } - - $tags = []; - - if ($scope == SR_SCOPE_TAGS) { - $server_tags = Config::get('system', 'relay_server_tags'); - $tagitems = explode(",", $server_tags); - - /// @todo Check if it was better to use "strtolower" on the tags - foreach ($tagitems AS $tag) { - $tag = trim($tag, "# "); - $tags[$tag] = $tag; - } - - if (Config::get('system', 'relay_user_tags')) { - $terms = q("SELECT DISTINCT(`term`) FROM `search`"); - - foreach ($terms AS $term) { - $tag = trim($term["term"], "#"); - $tags[$tag] = $tag; - } - } - } - - $taglist = []; - foreach ($tags AS $tag) { - if (!empty($tag)) { - $taglist[] = $tag; - } - } - - $relay = [ - 'subscribe' => $subscribe, - 'scope' => $scope, - 'tags' => $taglist, - 'protocols' => ['diaspora' => ['receive' => System::baseUrl() . '/receive/public'], - 'dfrn' => ['receive' => System::baseUrl() . '/dfrn_notify']] - ]; - - header('Content-type: application/json; charset=utf-8'); - echo json_encode($relay, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES); - exit; -} diff --git a/mod/webfinger.php b/mod/webfinger.php deleted file mode 100644 index b22b1ee64..000000000 --- a/mod/webfinger.php +++ /dev/null @@ -1,42 +0,0 @@ - L10n::t("Public access denied."), - "description" => L10n::t("Only logged in users are permitted to perform a probing.") - ] - ); - exit(); - } - - $o = '
'; - $o .= '

Webfinger Diagnostic

'; - - $o .= '
'; - $o .= 'Lookup address: '; - $o .= '
'; - - $o .= '

'; - - if (!empty($_GET['addr'])) { - $addr = trim($_GET['addr']); - $res = Probe::lrdd($addr); - $o .= '
';
-		$o .= str_replace("\n", '
', print_r($res, true));
-		$o .= '
'; - } - $o .= '
'; - - return $o; -} diff --git a/mod/xrd.php b/mod/xrd.php deleted file mode 100644 index b4cb60afe..000000000 --- a/mod/xrd.php +++ /dev/null @@ -1,134 +0,0 @@ -argv[0] == 'xrd') { - if (empty($_GET['uri'])) { - System::httpExit(404); - } - - $uri = urldecode(Strings::escapeTags(trim($_GET['uri']))); - if (defaults($_SERVER, 'HTTP_ACCEPT', '') == 'application/jrd+json') { - $mode = 'json'; - } else { - $mode = 'xml'; - } - } else { - if (empty($_GET['resource'])) { - System::httpExit(404); - } - - $uri = urldecode(Strings::escapeTags(trim($_GET['resource']))); - if (defaults($_SERVER, 'HTTP_ACCEPT', '') == 'application/xrd+xml') { - $mode = 'xml'; - } else { - $mode = 'json'; - } - } - - if (substr($uri, 0, 4) === 'http') { - $name = ltrim(basename($uri), '~'); - } else { - $local = str_replace('acct:', '', $uri); - if (substr($local, 0, 2) == '//') { - $local = substr($local, 2); - } - - $name = substr($local, 0, strpos($local, '@')); - } - - $user = DBA::selectFirst('user', [], ['nickname' => $name]); - if (!DBA::isResult($user)) { - System::httpExit(404); - } - - $profile_url = System::baseUrl().'/profile/'.$user['nickname']; - - $alias = str_replace('/profile/', '/~', $profile_url); - - $addr = 'acct:'.$user['nickname'].'@'.$a->getHostName(); - if ($a->getURLPath()) { - $addr .= '/'.$a->getURLPath(); - } - - if ($mode == 'xml') { - xrd_xml($addr, $alias, $profile_url, $user); - } else { - xrd_json($addr, $alias, $profile_url, $user); - } -} - -function xrd_json($uri, $alias, $profile_url, $r) -{ - $salmon_key = Salmon::salmonKey($r['spubkey']); - - header('Access-Control-Allow-Origin: *'); - header("Content-type: application/json; charset=utf-8"); - - $json = ['subject' => $uri, - 'aliases' => [$alias, $profile_url], - 'links' => [ - ['rel' => NAMESPACE_DFRN, 'href' => $profile_url], - ['rel' => NAMESPACE_FEED, 'type' => 'application/atom+xml', 'href' => System::baseUrl().'/dfrn_poll/'.$r['nickname']], - ['rel' => 'http://webfinger.net/rel/profile-page', 'type' => 'text/html', 'href' => $profile_url], - ['rel' => 'self', 'type' => 'application/activity+json', 'href' => $profile_url], - ['rel' => 'http://microformats.org/profile/hcard', 'type' => 'text/html', 'href' => System::baseUrl().'/hcard/'.$r['nickname']], - ['rel' => NAMESPACE_POCO, 'href' => System::baseUrl().'/poco/'.$r['nickname']], - ['rel' => 'http://webfinger.net/rel/avatar', 'type' => 'image/jpeg', 'href' => System::baseUrl().'/photo/profile/'.$r['uid'].'.jpg'], - ['rel' => 'http://joindiaspora.com/seed_location', 'type' => 'text/html', 'href' => System::baseUrl()], - ['rel' => 'salmon', 'href' => System::baseUrl().'/salmon/'.$r['nickname']], - ['rel' => 'http://salmon-protocol.org/ns/salmon-replies', 'href' => System::baseUrl().'/salmon/'.$r['nickname']], - ['rel' => 'http://salmon-protocol.org/ns/salmon-mention', 'href' => System::baseUrl().'/salmon/'.$r['nickname'].'/mention'], - ['rel' => 'http://ostatus.org/schema/1.0/subscribe', 'template' => System::baseUrl().'/follow?url={uri}'], - ['rel' => 'magic-public-key', 'href' => 'data:application/magic-public-key,'.$salmon_key], - ['rel' => 'http://purl.org/openwebauth/v1', 'type' => 'application/x-zot+json', 'href' => System::baseUrl().'/owa'] - ] - ]; - - echo json_encode($json); - exit(); -} - -function xrd_xml($uri, $alias, $profile_url, $r) -{ - $salmon_key = Salmon::salmonKey($r['spubkey']); - - header('Access-Control-Allow-Origin: *'); - header("Content-type: text/xml"); - - $tpl = Renderer::getMarkupTemplate('xrd_person.tpl'); - - $o = Renderer::replaceMacros($tpl, [ - '$nick' => $r['nickname'], - '$accturi' => $uri, - '$alias' => $alias, - '$profile_url' => $profile_url, - '$hcard_url' => System::baseUrl() . '/hcard/' . $r['nickname'], - '$atom' => System::baseUrl() . '/dfrn_poll/' . $r['nickname'], - '$poco_url' => System::baseUrl() . '/poco/' . $r['nickname'], - '$photo' => System::baseUrl() . '/photo/profile/' . $r['uid'] . '.jpg', - '$baseurl' => System::baseUrl(), - '$salmon' => System::baseUrl() . '/salmon/' . $r['nickname'], - '$salmen' => System::baseUrl() . '/salmon/' . $r['nickname'] . '/mention', - '$subscribe' => System::baseUrl() . '/follow?url={uri}', - '$openwebauth' => System::baseUrl() . '/owa', - '$modexp' => 'data:application/magic-public-key,' . $salmon_key] - ); - - $arr = ['user' => $r, 'xml' => $o]; - Hook::callAll('personal_xrd', $arr); - - echo $arr['xml']; - exit(); -} diff --git a/src/App/Router.php b/src/App/Router.php index 53fe0689a..c17398977 100644 --- a/src/App/Router.php +++ b/src/App/Router.php @@ -44,6 +44,14 @@ class Router $this->routeCollector->addRoute(['GET'], '/amcd', Module\AccountManagementControlDocument::class); $this->routeCollector->addRoute(['GET'], '/host-meta', Module\HostMeta::class); $this->routeCollector->addRoute(['GET'], '/hostxrd', Module\HostMeta::class); + $this->routeCollector->addRoute(['GET'], '/nodeinfo/1.0', Module\NodeInfo::class); + $this->routeCollector->addRoute(['GET'], '/xrd', Module\WebFinger::class); + $this->routeCollector->addGroup('/.well-known', function (RouteCollector $collector) { + $collector->addRoute(['GET'], '/host-meta' , Module\WellKnown\HostMeta::class); + $collector->addRoute(['GET'], '/nodeinfo[/1.0]' , Module\NodeInfo::class); + $collector->addRoute(['GET'], '/webfinger[/xrd]' , Module\WebFinger::class); + $collector->addRoute(['GET'], '/x-social-relay' , Module\WellKnown\XSocialRelay::class); + }); } public function __construct(RouteCollector $routeCollector = null) diff --git a/src/Model/Search.php b/src/Model/Search.php new file mode 100644 index 000000000..5829ff91d --- /dev/null +++ b/src/Model/Search.php @@ -0,0 +1,32 @@ + $uid]); + return DBA::selectFirst('user', $fields, ['uid' => $uid]); + } + + /** + * @param string $nickname + * @param array $fields + * @return array|boolean User record if it exists, false otherwise + * @throws Exception + */ + public static function getByNickname($nickname, array $fields = []) + { + return DBA::selectFirst('user', $fields, ['nickname' => $nickname]); } /** diff --git a/src/Module/Nodeinfo.php b/src/Module/NodeInfo.php similarity index 95% rename from src/Module/Nodeinfo.php rename to src/Module/NodeInfo.php index 18f2c7280..7fad79fd3 100644 --- a/src/Module/Nodeinfo.php +++ b/src/Module/NodeInfo.php @@ -8,9 +8,10 @@ use Friendica\Core\Addon; use Friendica\Core\System; /** - * Prints infos about the current node + * Standardized way of exposing metadata about a server running one of the distributed social networks. + * @see https://github.com/jhass/nodeinfo/blob/master/PROTOCOL.md */ -class Nodeinfo extends BaseModule +class NodeInfo extends BaseModule { /** * Prints the Nodeinfo for a well-known request @@ -48,7 +49,7 @@ class Nodeinfo extends BaseModule } if (($app->argc != 2) || ($app->argv[1] != '1.0')) { - System::httpExit(404); + self::printWellKnown($app); } } diff --git a/src/Module/WebFinger.php b/src/Module/WebFinger.php new file mode 100644 index 000000000..d456c6aac --- /dev/null +++ b/src/Module/WebFinger.php @@ -0,0 +1,235 @@ + L10n::t("Public access denied."), + "description" => L10n::t("Only logged in users are permitted to perform a probing.") + ] + ); + exit(); + } + + $output = '
'; + $output .= '

Webfinger Diagnostic

'; + + $output .= '
'; + $output .= 'Lookup address: '; + $output .= '
'; + + $output .= '

'; + + if (!empty($_GET['addr'])) { + $addr = trim($_GET['addr']); + $res = Probe::lrdd($addr); + $output .= '
';
+			$output .= str_replace("\n", '
', print_r($res, true));
+			$output .= '
'; + } + $output .= '
'; + + return $output; + } + + public static function rawContent() + { + parent::rawContent(); + + $app = self::getApp(); + + // @TODO: Replace with parameter from router + if ($app->argv[0] == 'xrd') { + if (empty($_GET['uri'])) { + return; + } + + $uri = urldecode(Strings::escapeTags(trim($_GET['uri']))); + if (defaults($_SERVER, 'HTTP_ACCEPT', '') == 'application/jrd+json') { + $mode = 'json'; + } else { + $mode = 'xml'; + } + } else { + if (empty($_GET['resource'])) { + return; + } + + $uri = urldecode(Strings::escapeTags(trim($_GET['resource']))); + if (defaults($_SERVER, 'HTTP_ACCEPT', '') == 'application/xrd+xml') { + $mode = 'xml'; + } else { + $mode = 'json'; + } + } + + if (substr($uri, 0, 4) === 'http') { + $name = ltrim(basename($uri), '~'); + } else { + $local = str_replace('acct:', '', $uri); + if (substr($local, 0, 2) == '//') { + $local = substr($local, 2); + } + + $name = substr($local, 0, strpos($local, '@')); + } + + $user = User::getByNickname($name); + + if (empty($user)) { + System::httpExit(404); + } + + $profileURL = $app->getBaseURL() . '/profile/' . $user['nickname']; + $alias = str_replace('/profile/', '/~', $profileURL); + + $addr = 'acct:' . $user['nickname'] . '@' . $app->getHostName(); + if ($app->getURLPath()) { + $addr .= '/' . $app->getURLPath(); + } + + if ($mode == 'xml') { + self::printXML($addr, $alias, $profileURL, $app->getBaseURL(), $user); + } else { + self::printJSON($addr, $alias, $profileURL, $app->getBaseURL(), $user); + } + } + + private static function printJSON($uri, $alias, $orofileURL, $baseURL, $user) + { + $salmon_key = Salmon::salmonKey($user['spubkey']); + + header('Access-Control-Allow-Origin: *'); + header("Content-type: application/json; charset=utf-8"); + + $json = ['subject' => $uri, + 'aliases' => [ + $alias, + $orofileURL, + ], + 'links' => [ + [ + 'rel' => NAMESPACE_DFRN, + 'href' => $orofileURL, + ], + [ + 'rel' => NAMESPACE_FEED, + 'type' => 'application/atom+xml', + 'href' => $baseURL . '/dfrn_poll/' . $user['nickname'], + ], + [ + 'rel' => 'http://webfinger.net/rel/profile-page', + 'type' => 'text/html', + 'href' => $orofileURL, + ], + [ + 'rel' => 'self', + 'type' => 'application/activity+json', + 'href' => $orofileURL, + ], + [ + 'rel' => 'http://microformats.org/profile/hcard', + 'type' => 'text/html', + 'href' => $baseURL . '/hcard/' . $user['nickname'], + ], + [ + 'rel' => NAMESPACE_POCO, + 'href' => $baseURL . '/poco/' . $user['nickname'], + ], + [ + 'rel' => 'http://webfinger.net/rel/avatar', + 'type' => 'image/jpeg', + 'href' => $baseURL . '/photo/profile/' . $user['uid'] . '.jpg', + ], + [ + 'rel' => 'http://joindiaspora.com/seed_location', + 'type' => 'text/html', + 'href' => $baseURL, + ], + [ + 'rel' => 'salmon', + 'href' => $baseURL . '/salmon/' . $user['nickname'], + ], + [ + 'rel' => 'http://salmon-protocol.org/ns/salmon-replies', + 'href' => $baseURL . '/salmon/' . $user['nickname'], + ], + [ + 'rel' => 'http://salmon-protocol.org/ns/salmon-mention', + 'href' => $baseURL . '/salmon/' . $user['nickname'] . '/mention', + ], + [ + 'rel' => 'http://ostatus.org/schema/1.0/subscribe', + 'template' => $baseURL . '/follow?url={uri}', + ], + [ + 'rel' => 'magic-public-key', + 'href' => 'data:application/magic-public-key,' . $salmon_key, + ], + [ + 'rel' => 'http://purl.org/openwebauth/v1', + 'type' => 'application/x-zot+json', + 'href' => $baseURL . '/owa', + ], + ], + ]; + + echo json_encode($json); + exit(); + } + + private static function printXML($uri, $alias, $profileURL, $baseURL, $user) + { + $salmon_key = Salmon::salmonKey($user['spubkey']); + + header('Access-Control-Allow-Origin: *'); + header("Content-type: text/xml"); + + $tpl = Renderer::getMarkupTemplate('xrd_person.tpl'); + + $o = Renderer::replaceMacros($tpl, [ + '$nick' => $user['nickname'], + '$accturi' => $uri, + '$alias' => $alias, + '$profile_url' => $profileURL, + '$hcard_url' => $baseURL . '/hcard/' . $user['nickname'], + '$atom' => $baseURL . '/dfrn_poll/' . $user['nickname'], + '$poco_url' => $baseURL . '/poco/' . $user['nickname'], + '$photo' => $baseURL . '/photo/profile/' . $user['uid'] . '.jpg', + '$baseurl' => $baseURL, + '$salmon' => $baseURL . '/salmon/' . $user['nickname'], + '$salmen' => $baseURL . '/salmon/' . $user['nickname'] . '/mention', + '$subscribe' => $baseURL . '/follow?url={uri}', + '$openwebauth' => $baseURL . '/owa', + '$modexp' => 'data:application/magic-public-key,' . $salmon_key] + ); + + $arr = ['user' => $user, 'xml' => $o]; + Hook::callAll('personal_xrd', $arr); + + echo $arr['xml']; + exit(); + } +} diff --git a/src/Module/HostMeta.php b/src/Module/WellKnown/HostMeta.php similarity index 76% rename from src/Module/HostMeta.php rename to src/Module/WellKnown/HostMeta.php index 21953b541..282781adf 100644 --- a/src/Module/HostMeta.php +++ b/src/Module/WellKnown/HostMeta.php @@ -1,6 +1,6 @@ getConfig(); diff --git a/src/Module/WellKnown/XSocialRelay.php b/src/Module/WellKnown/XSocialRelay.php new file mode 100644 index 000000000..5766a8ce5 --- /dev/null +++ b/src/Module/WellKnown/XSocialRelay.php @@ -0,0 +1,62 @@ +getConfig(); + + $subscribe = $config->get('system', 'relay_subscribe', false); + + if ($subscribe) { + $scope = $config->get('system', 'relay_scope', SR_SCOPE_ALL); + } else { + $scope = SR_SCOPE_NONE; + } + + $systemTags = []; + $userTags = []; + + if ($scope == SR_SCOPE_TAGS) { + $server_tags = $config->get('system', 'relay_server_tags'); + $tagitems = explode(",", $server_tags); + + /// @todo Check if it was better to use "strtolower" on the tags + foreach ($tagitems AS $tag) { + $systemTags[] = trim($tag, "# "); + } + + if ($config->get('system', 'relay_user_tags')) { + $userTags = Search::getUserTags(); + } + } + + $tagList = array_unique(array_merge($systemTags, $userTags)); + + $relay = [ + 'subscribe' => $subscribe, + 'scope' => $scope, + 'tags' => $tagList, + 'protocols' => ['diaspora' => + ['receive' => $app->getBaseURL() . '/receive/public'], + 'dfrn' => + ['receive' => $app->getBaseURL() . '/dfrn_notify']] + ]; + + header('Content-type: application/json; charset=utf-8'); + echo json_encode($relay, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES); + exit; + } +}