Merge pull request #7873 from annando/nodeinfo

nodeinfo version 2 / basic nodeinfo data is always enabled
This commit is contained in:
Hypolite Petovan 2019-11-28 12:57:50 -05:00 committed by GitHub
commit 20b725f07b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 221 additions and 126 deletions

View file

@ -13,84 +13,131 @@ use Friendica\Core\System;
*/ */
class NodeInfo extends BaseModule class NodeInfo extends BaseModule
{ {
public static function init(array $parameters = [])
{
$config = self::getApp()->getConfig();
if (!$config->get('system', 'nodeinfo')) {
throw new \Friendica\Network\HTTPException\NotFoundException();
}
}
public static function rawContent(array $parameters = []) public static function rawContent(array $parameters = [])
{ {
$app = self::getApp(); $app = self::getApp();
// @TODO: Replace with parameter from router if ($parameters['version'] == '1.0') {
// if the first argument is ".well-known", print the well-known text self::printNodeInfo1($app);
if (($app->argc > 1) && ($app->argv[0] == '.well-known')) { } elseif ($parameters['version'] == '2.0') {
self::printWellKnown($app); self::printNodeInfo2($app);
// otherwise print the nodeinfo
} else { } else {
self::printNodeInfo($app);
}
}
/**
* Prints the well-known nodeinfo redirect
*
* @param App $app
*
* @throws \Friendica\Network\HTTPException\NotFoundException
*/
private static function printWellKnown(App $app)
{
$config = $app->getConfig();
if (!$config->get('system', 'nodeinfo')) {
throw new \Friendica\Network\HTTPException\NotFoundException(); throw new \Friendica\Network\HTTPException\NotFoundException();
} }
$nodeinfo = [
'links' => [[
'rel' => 'http://nodeinfo.diaspora.software/ns/schema/1.0',
'href' => $app->getBaseURL() . '/nodeinfo/1.0']]
];
header('Content-type: application/json; charset=utf-8');
echo json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
exit;
} }
/** /**
* Print the nodeinfo * Return the supported services
* *
* @param App $app * @param App $app
*/ *
private static function printNodeInfo(App $app) * @return array with supported services
*/
private static function getUsage(App $app)
{ {
$config = $app->getConfig(); $config = $app->getConfig();
$smtp = (function_exists('imap_open') && !$config->get('system', 'imap_disabled') && !$config->get('system', 'dfrn_only')); $usage = [];
if (!empty($config->get('system', 'nodeinfo'))) {
$usage['users'] = [
'total' => intval($config->get('nodeinfo', 'total_users')),
'activeHalfyear' => intval($config->get('nodeinfo', 'active_users_halfyear')),
'activeMonth' => intval($config->get('nodeinfo', 'active_users_monthly'))
];
$usage['localPosts'] = intval($config->get('nodeinfo', 'local_posts'));
$usage['localComments'] = intval($config->get('nodeinfo', 'local_comments'));
}
return $usage;
}
/**
* Return the supported services
*
* @param App $app
*
* @return array with supported services
*/
private static function getServices(App $app)
{
$services = [
'inbound' => [],
'outbound' => [],
];
if (Addon::isEnabled('blogger')) {
$services['outbound'][] = 'blogger';
}
if (Addon::isEnabled('dwpost')) {
$services['outbound'][] = 'dreamwidth';
}
if (Addon::isEnabled('statusnet')) {
$services['inbound'][] = 'gnusocial';
$services['outbound'][] = 'gnusocial';
}
if (Addon::isEnabled('ijpost')) {
$services['outbound'][] = 'insanejournal';
}
if (Addon::isEnabled('libertree')) {
$services['outbound'][] = 'libertree';
}
if (Addon::isEnabled('buffer')) {
$services['outbound'][] = 'linkedin';
}
if (Addon::isEnabled('ljpost')) {
$services['outbound'][] = 'livejournal';
}
if (Addon::isEnabled('buffer')) {
$services['outbound'][] = 'pinterest';
}
if (Addon::isEnabled('posterous')) {
$services['outbound'][] = 'posterous';
}
if (Addon::isEnabled('pumpio')) {
$services['inbound'][] = 'pumpio';
$services['outbound'][] = 'pumpio';
}
$services['outbound'][] = 'smtp';
if (Addon::isEnabled('tumblr')) {
$services['outbound'][] = 'tumblr';
}
if (Addon::isEnabled('twitter') || Addon::isEnabled('buffer')) {
$services['outbound'][] = 'twitter';
}
if (Addon::isEnabled('wppost')) {
$services['outbound'][] = 'wordpress';
}
return $services;
}
/**
* Print the nodeinfo version 1
*
* @param App $app
*/
private static function printNodeInfo1(App $app)
{
$config = $app->getConfig();
$nodeinfo = [ $nodeinfo = [
'version' => 1.0, 'version' => '1.0',
'software' => [ 'software' => [
'name' => 'friendica', 'name' => 'friendica',
'version' => FRIENDICA_VERSION . '-' . DB_UPDATE_VERSION, 'version' => FRIENDICA_VERSION . '-' . DB_UPDATE_VERSION,
], ],
'protocols' => [ 'protocols' => [
'inbound' => [ 'inbound' => [
'friendica', 'friendica', 'activitypub'
], ],
'outbound' => [ 'outbound' => [
'friendica', 'friendica', 'activitypub'
], ],
], ],
'services' => [ 'services' => [],
'inbound' => [],
'outbound' => [],
],
'usage' => [], 'usage' => [],
'openRegistrations' => intval($config->get('config', 'register_policy')) !== Register::CLOSED, 'openRegistrations' => intval($config->get('config', 'register_policy')) !== Register::CLOSED,
'metadata' => [ 'metadata' => [
@ -108,75 +155,80 @@ class NodeInfo extends BaseModule
$nodeinfo['protocols']['outbound'][] = 'gnusocial'; $nodeinfo['protocols']['outbound'][] = 'gnusocial';
} }
if (!empty($config->get('system', 'nodeinfo'))) { $nodeinfo['usage'] = self::getUsage($app);
$nodeinfo['usage']['users'] = [ $nodeinfo['services'] = self::getServices($app);
'total' => intval($config->get('nodeinfo', 'total_users')),
'activeHalfyear' => intval($config->get('nodeinfo', 'active_users_halfyear')),
'activeMonth' => intval($config->get('nodeinfo', 'active_users_monthly'))
];
$nodeinfo['usage']['localPosts'] = intval($config->get('nodeinfo', 'local_posts'));
$nodeinfo['usage']['localComments'] = intval($config->get('nodeinfo', 'local_comments'));
if (Addon::isEnabled('blogger')) { $nodeinfo['metadata']['protocols'] = $nodeinfo['protocols'];
$nodeinfo['services']['outbound'][] = 'blogger'; $nodeinfo['metadata']['protocols']['outbound'][] = 'atom1.0';
} $nodeinfo['metadata']['protocols']['inbound'][] = 'atom1.0';
if (Addon::isEnabled('dwpost')) { $nodeinfo['metadata']['protocols']['inbound'][] = 'rss2.0';
$nodeinfo['services']['outbound'][] = 'dreamwidth';
}
if (Addon::isEnabled('statusnet')) {
$nodeinfo['services']['inbound'][] = 'gnusocial';
$nodeinfo['services']['outbound'][] = 'gnusocial';
}
if (Addon::isEnabled('ijpost')) {
$nodeinfo['services']['outbound'][] = 'insanejournal';
}
if (Addon::isEnabled('libertree')) {
$nodeinfo['services']['outbound'][] = 'libertree';
}
if (Addon::isEnabled('buffer')) {
$nodeinfo['services']['outbound'][] = 'linkedin';
}
if (Addon::isEnabled('ljpost')) {
$nodeinfo['services']['outbound'][] = 'livejournal';
}
if (Addon::isEnabled('buffer')) {
$nodeinfo['services']['outbound'][] = 'pinterest';
}
if (Addon::isEnabled('posterous')) {
$nodeinfo['services']['outbound'][] = 'posterous';
}
if (Addon::isEnabled('pumpio')) {
$nodeinfo['services']['inbound'][] = 'pumpio';
$nodeinfo['services']['outbound'][] = 'pumpio';
}
if ($smtp) { $nodeinfo['metadata']['services'] = $nodeinfo['services'];
$nodeinfo['services']['outbound'][] = 'smtp';
}
if (Addon::isEnabled('tumblr')) {
$nodeinfo['services']['outbound'][] = 'tumblr';
}
if (Addon::isEnabled('twitter') || Addon::isEnabled('buffer')) {
$nodeinfo['services']['outbound'][] = 'twitter';
}
if (Addon::isEnabled('wppost')) {
$nodeinfo['services']['outbound'][] = 'wordpress';
}
$nodeinfo['metadata']['protocols'] = $nodeinfo['protocols'];
$nodeinfo['metadata']['protocols']['outbound'][] = 'atom1.0';
$nodeinfo['metadata']['protocols']['inbound'][] = 'atom1.0';
$nodeinfo['metadata']['protocols']['inbound'][] = 'rss2.0';
$nodeinfo['metadata']['services'] = $nodeinfo['services']; if (Addon::isEnabled('twitter')) {
$nodeinfo['metadata']['services']['inbound'][] = 'twitter';
if (Addon::isEnabled('twitter')) {
$nodeinfo['metadata']['services']['inbound'][] = 'twitter';
}
$nodeinfo['metadata']['explicitContent'] = $config->get('system', 'explicit_content', false) == true;
} }
$nodeinfo['metadata']['explicitContent'] = $config->get('system', 'explicit_content', false) == true;
header('Content-type: application/json; charset=utf-8');
echo json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
exit;
}
/**
* Print the nodeinfo version 2
*
* @param App $app
*/
private static function printNodeInfo2(App $app)
{
$config = $app->getConfig();
$imap = (function_exists('imap_open') && !$config->get('system', 'imap_disabled') && !$config->get('system', 'dfrn_only'));
$nodeinfo = [
'version' => '2.0',
'software' => [
'name' => 'friendica',
'version' => FRIENDICA_VERSION . '-' . DB_UPDATE_VERSION,
],
'protocols' => ['dfrn', 'activitypub'],
'services' => [],
'usage' => [],
'openRegistrations' => intval($config->get('config', 'register_policy')) !== Register::CLOSED,
'metadata' => [
'nodeName' => $config->get('config', 'sitename'),
],
];
if (!empty($config->get('system', 'diaspora_enabled'))) {
$nodeinfo['protocols'][] = 'diaspora';
}
if (empty($config->get('system', 'ostatus_disabled'))) {
$nodeinfo['protocols'][] = 'ostatus';
}
$nodeinfo['usage'] = self::getUsage($app);
$nodeinfo['services'] = self::getServices($app);
if (Addon::isEnabled('twitter')) {
$nodeinfo['services']['inbound'][] = 'twitter';
}
$nodeinfo['services']['inbound'][] = 'atom1.0';
$nodeinfo['services']['inbound'][] = 'rss2.0';
$nodeinfo['services']['outbound'][] = 'atom1.0';
if ($imap) {
$nodeinfo['services']['inbound'][] = 'imap';
}
$nodeinfo['metadata']['explicitContent'] = $config->get('system', 'explicit_content', false) == true;
header('Content-type: application/json; charset=utf-8'); header('Content-type: application/json; charset=utf-8');
echo json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES); echo json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
exit; exit;

View file

@ -0,0 +1,43 @@
<?php
namespace Friendica\Module\WellKnown;
use Friendica\App;
use Friendica\BaseModule;
/**
* 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
{
public static function rawContent(array $parameters = [])
{
$app = self::getApp();
self::printWellKnown($app);
}
/**
* Prints the well-known nodeinfo redirect
*
* @param App $app
*
* @throws \Friendica\Network\HTTPException\NotFoundException
*/
private static function printWellKnown(App $app)
{
$nodeinfo = [
'links' => [
['rel' => 'http://nodeinfo.diaspora.software/ns/schema/1.0',
'href' => $app->getBaseURL() . '/nodeinfo/1.0'],
['rel' => 'http://nodeinfo.diaspora.software/ns/schema/2.0',
'href' => $app->getBaseURL() . '/nodeinfo/2.0'],
]
];
header('Content-type: application/json; charset=utf-8');
echo json_encode($nodeinfo, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
exit;
}
}

View file

@ -17,7 +17,7 @@ return [
'/.well-known' => [ '/.well-known' => [
'/host-meta' => [Module\WellKnown\HostMeta::class, [R::GET]], '/host-meta' => [Module\WellKnown\HostMeta::class, [R::GET]],
'/nodeinfo[/1.0]' => [Module\NodeInfo::class, [R::GET]], '/nodeinfo' => [Module\WellKnown\NodeInfo::class, [R::GET]],
'/webfinger' => [Module\Xrd::class, [R::GET]], '/webfinger' => [Module\Xrd::class, [R::GET]],
'/x-social-relay' => [Module\WellKnown\XSocialRelay::class, [R::GET]], '/x-social-relay' => [Module\WellKnown\XSocialRelay::class, [R::GET]],
], ],
@ -145,17 +145,17 @@ return [
'/ignore/{id}' => [Module\Item\Ignore::class, [R::GET]], '/ignore/{id}' => [Module\Item\Ignore::class, [R::GET]],
], ],
'/like/{item:\d+}' => [Module\Like::class, [R::GET]], '/like/{item:\d+}' => [Module\Like::class, [R::GET]],
'/localtime' => [Module\Debug\Localtime::class, [R::GET, R::POST]], '/localtime' => [Module\Debug\Localtime::class, [R::GET, R::POST]],
'/login' => [Module\Login::class, [R::GET, R::POST]], '/login' => [Module\Login::class, [R::GET, R::POST]],
'/logout' => [Module\Logout::class, [R::GET, R::POST]], '/logout' => [Module\Logout::class, [R::GET, R::POST]],
'/magic' => [Module\Magic::class, [R::GET]], '/magic' => [Module\Magic::class, [R::GET]],
'/maintenance' => [Module\Maintenance::class, [R::GET]], '/maintenance' => [Module\Maintenance::class, [R::GET]],
'/manifest' => [Module\Manifest::class, [R::GET]], '/manifest' => [Module\Manifest::class, [R::GET]],
'/modexp/{nick}' => [Module\PublicRSAKey::class, [R::GET]], '/modexp/{nick}' => [Module\PublicRSAKey::class, [R::GET]],
'/newmember' => [Module\Welcome::class, [R::GET]], '/newmember' => [Module\Welcome::class, [R::GET]],
'/nodeinfo/1.0' => [Module\NodeInfo::class, [R::GET]], '/nodeinfo/{version}' => [Module\NodeInfo::class, [R::GET]],
'/nogroup' => [Module\Group::class, [R::GET]], '/nogroup' => [Module\Group::class, [R::GET]],
'/notify' => [ '/notify' => [
'[/]' => [Module\Notifications\Notify::class, [R::GET]], '[/]' => [Module\Notifications\Notify::class, [R::GET]],