<?php
-
/**
- * @file src/Model/GServer.php
- * @brief This file includes the GServer class to handle with servers
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program. If not, see <https://www.gnu.org/licenses/>.
+ *
*/
+
namespace Friendica\Model;
use DOMDocument;
use DOMXPath;
-use Friendica\Core\Config;
use Friendica\Core\Protocol;
+use Friendica\Core\Worker;
use Friendica\Database\DBA;
+use Friendica\DI;
use Friendica\Module\Register;
+use Friendica\Network\CurlResult;
use Friendica\Util\Network;
use Friendica\Util\DateTimeFormat;
use Friendica\Util\Strings;
use Friendica\Core\Logger;
use Friendica\Protocol\PortableContact;
use Friendica\Protocol\Diaspora;
+use Friendica\Network\Probe;
/**
- * @brief This class handles GServer related functions
+ * This class handles GServer related functions
*/
class GServer
{
- public static function check($server_url, $force = false)
+ // Directory types
+ const DT_NONE = 0;
+ const DT_POCO = 1;
+ const DT_MASTODON = 2;
+ /**
+ * Checks if the given server is reachable
+ *
+ * @param string $profile URL of the given profile
+ * @param string $server URL of the given server (If empty, taken from profile)
+ * @param string $network Network value that is used, when detection failed
+ * @param boolean $force Force an update.
+ *
+ * @return boolean 'true' if server seems vital
+ */
+ public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false)
+ {
+ if ($server == '') {
+ $server = GContact::getBasepath($profile);
+ }
+
+ if ($server == '') {
+ return true;
+ }
+
+ return self::check($server, $network, $force);
+ }
+
+ /**
+ * Decides if a server needs to be updated, based upon several date fields
+ *
+ * @param date $created Creation date of that server entry
+ * @param date $updated When had the server entry be updated
+ * @param date $last_failure Last failure when contacting that server
+ * @param date $last_contact Last time the server had been contacted
+ *
+ * @return boolean Does the server record needs an update?
+ */
+ public static function updateNeeded($created, $updated, $last_failure, $last_contact)
+ {
+ $now = strtotime(DateTimeFormat::utcNow());
+
+ if ($updated > $last_contact) {
+ $contact_time = strtotime($updated);
+ } else {
+ $contact_time = strtotime($last_contact);
+ }
+
+ $failure_time = strtotime($last_failure);
+ $created_time = strtotime($created);
+
+ // If there is no "created" time then use the current time
+ if ($created_time <= 0) {
+ $created_time = $now;
+ }
+
+ // If the last contact was less than 24 hours then don't update
+ if (($now - $contact_time) < (60 * 60 * 24)) {
+ return false;
+ }
+
+ // If the last failure was less than 24 hours then don't update
+ if (($now - $failure_time) < (60 * 60 * 24)) {
+ return false;
+ }
+
+ // If the last contact was less than a week ago and the last failure is older than a week then don't update
+ //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
+ // return false;
+
+ // If the last contact time was more than a week ago and the contact was created more than a week ago, then only try once a week
+ if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
+ return false;
+ }
+
+ // If the last contact time was more than a month ago and the contact was created more than a month ago, then only try once a month
+ if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
+ return false;
+ }
+
+ return true;
+ }
+
+ /**
+ * Checks the state of the given server.
+ *
+ * @param string $server_url URL of the given server
+ * @param string $network Network value that is used, when detection failed
+ * @param boolean $force Force an update.
+ * @param boolean $only_nodeinfo Only use nodeinfo for server detection
+ *
+ * @return boolean 'true' if server seems vital
+ */
+ public static function check(string $server_url, string $network = '', bool $force = false, bool $only_nodeinfo = false)
{
// Unify the server address
$server_url = trim($server_url, '/');
DBA::update('gserver', $fields, $condition);
}
- $last_contact = $gserver["last_contact"];
- $last_failure = $gserver["last_failure"];
+ $last_contact = $gserver['last_contact'];
+ $last_failure = $gserver['last_failure'];
// See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
// It can happen that a zero date is in the database, but storing it again is forbidden.
$last_failure = DBA::NULL_DATETIME;
}
- if (!$force && !PortableContact::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
- Logger::info('Use cached data', ['server' => $server_url]);
+ if (!$force && !self::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
+ Logger::info('No update needed', ['server' => $server_url]);
return ($last_contact >= $last_failure);
}
+ Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
+ } else {
+ Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
}
- Logger::info('Server is outdated or unknown. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
- return self::detect($server_url);
+ return self::detect($server_url, $network, $only_nodeinfo);
+ }
+
+ /**
+ * Set failed server status
+ *
+ * @param string $url
+ */
+ private static function setFailure(string $url)
+ {
+ if (DBA::exists('gserver', ['nurl' => Strings::normaliseLink($url)])) {
+ DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
+ Logger::info('Set failed status for existing server', ['url' => $url]);
+ return;
+ }
+ DBA::insert('gserver', ['url' => $url, 'nurl' => Strings::normaliseLink($url),
+ 'network' => Protocol::PHANTOM, 'created' => DateTimeFormat::utcNow(),
+ 'last_failure' => DateTimeFormat::utcNow()]);
+ Logger::info('Set failed status for new server', ['url' => $url]);
}
/**
* Detect server data (type, protocol, version number, ...)
* The detected data is then updated or inserted in the gserver table.
*
- * @param string $url Server url
+ * @param string $url URL of the given server
+ * @param string $network Network value that is used, when detection failed
+ * @param boolean $only_nodeinfo Only use nodeinfo for server detection
*
* @return boolean 'true' if server could be detected
*/
- public static function detect($url)
+ public static function detect(string $url, string $network = '', bool $only_nodeinfo = false)
{
+ Logger::info('Detect server type', ['server' => $url]);
$serverdata = [];
+ $original_url = $url;
+
+ // Remove URL content that is not supposed to exist for a server url
+ $urlparts = parse_url($url);
+ unset($urlparts['user']);
+ unset($urlparts['pass']);
+ unset($urlparts['query']);
+ unset($urlparts['fragment']);
+ $url = Network::unparseURL($urlparts);
+
+ // If the URL missmatches, then we mark the old entry as failure
+ if ($url != $original_url) {
+ DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($original_url)]);
+ }
+
// When a nodeinfo is present, we don't need to dig further
- $xrd_timeout = Config::get('system', 'xrd_timeout');
+ $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
$curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
if ($curlResult->isTimeout()) {
- DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
+ self::setFailure($url);
return false;
}
$nodeinfo = self::fetchNodeinfo($url, $curlResult);
+ if ($only_nodeinfo && empty($nodeinfo)) {
+ Logger::info('Invalid nodeinfo in nodeinfo-mode, server is marked as failure', ['url' => $url]);
+ self::setFailure($url);
+ return false;
+ }
// When nodeinfo isn't present, we use the older 'statistics.json' endpoint
if (empty($nodeinfo)) {
}
// If that didn't work out well, we use some protocol specific endpoints
- if (empty($nodeinfo) || empty($nodeinfo['network']) || ($nodeinfo['network'] == Protocol::DFRN)) {
+ // For Friendica and Zot based networks we have to dive deeper to reveal more details
+ if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
// Fetch the landing page, possibly it reveals some data
- $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
- if ($curlResult->isSuccess()) {
- $serverdata = self::analyseRootHeader($curlResult, $serverdata);
- $serverdata = self::analyseRootBody($curlResult, $serverdata);
+ if (empty($nodeinfo['network'])) {
+ $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
+ if ($curlResult->isSuccess()) {
+ $serverdata = self::analyseRootHeader($curlResult, $serverdata);
+ $serverdata = self::analyseRootBody($curlResult, $serverdata, $url);
+ }
+
+ if (!$curlResult->isSuccess() || empty($curlResult->getBody()) || self::invalidBody($curlResult->getBody())) {
+ self::setFailure($url);
+ return false;
+ }
}
- if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
- DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
- return false;
+ if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
+ $serverdata = self::detectMastodonAlikes($url, $serverdata);
}
- if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::DFRN)) {
- $serverdata = self::detectFriendica($url, $serverdata);
+ // All following checks are done for systems that always have got a "host-meta" endpoint.
+ // With this check we don't have to waste time and ressources for dead systems.
+ // Also this hopefully prevents us from receiving abuse messages.
+ if (empty($serverdata['network']) && !self::validHostMeta($url)) {
+ self::setFailure($url);
+ return false;
}
- if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
- $serverdata = self::detectMastodonAlikes($url, $serverdata);
+ if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
+ $serverdata = self::detectFriendica($url, $serverdata);
}
// the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
$serverdata = $nodeinfo;
}
+ // Detect the directory type
+ $serverdata['directory-type'] = self::DT_NONE;
$serverdata = self::checkPoCo($url, $serverdata);
+ $serverdata = self::checkMastodonDirectory($url, $serverdata);
// We can't detect the network type. Possibly it is some system that we don't know yet
if (empty($serverdata['network'])) {
$serverdata['network'] = Protocol::PHANTOM;
}
- // Check host-meta for phantom networks.
- // Although this is not needed, it is a good indicator for a living system,
- // since most systems had implemented it.
- if (($serverdata['network'] == Protocol::PHANTOM) && !self::validHostMeta($url)) {
- DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
- return false;
+ // When we hadn't been able to detect the network type, we use the hint from the parameter
+ if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
+ $serverdata['network'] = $network;
}
$serverdata['url'] = $url;
$registeredUsers = 1;
}
- $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
- $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
- $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
- $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
+ if ($serverdata['network'] != Protocol::PHANTOM) {
+ $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
+ $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
+ $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
+ $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
+ } else {
+ $serverdata['registered-users'] = $registeredUsers;
+ $serverdata = self::detectNetworkViaContacts($url, $serverdata);
+ }
$serverdata['last_contact'] = DateTimeFormat::utcNow();
- if (!DBA::exists('gserver', ['nurl' => Strings::normaliseLink($url)])) {
+ $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
+ if (!DBA::isResult($gserver)) {
$serverdata['created'] = DateTimeFormat::utcNow();
$ret = DBA::insert('gserver', $serverdata);
} else {
+ // Don't override the network with 'unknown' when there had been a valid entry before
+ if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
+ unset($serverdata['network']);
+ }
+
$ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
}
- if (in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
+ if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
self::discoverRelay($url);
}
}
/**
- * @brief Fetch relay data from a given server url
+ * Fetch relay data from a given server url
*
* @param string $server_url address of the server
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function discoverRelay($server_url)
+ private static function discoverRelay(string $server_url)
{
Logger::info('Discover relay data', ['server' => $server_url]);
return;
}
+ // Sanitize incoming data, see https://github.com/friendica/friendica/issues/8565
+ $data['subscribe'] = (bool)$data['subscribe'] ?? false;
+
+ if (!$data['subscribe'] || empty($data['scope']) || !in_array(strtolower($data['scope']), ['all', 'tags'])) {
+ $data['scope'] = '';
+ $data['subscribe'] = false;
+ $data['tags'] = [];
+ }
+
$gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
if (!DBA::isResult($gserver)) {
return;
Diaspora::setRelayContact($server_url, $fields);
}
- private static function fetchStatistics($url)
+ /**
+ * Fetch server data from '/statistics.json' on the given server
+ *
+ * @param string $url URL of the given server
+ *
+ * @return array server data
+ */
+ private static function fetchStatistics(string $url)
{
$curlResult = Network::curl($url . '/statistics.json');
if (!$curlResult->isSuccess()) {
}
if (!empty($data['network'])) {
- $serverdata['platform'] = $data['network'];
+ $serverdata['platform'] = strtolower($data['network']);
- if ($serverdata['platform'] == 'Diaspora') {
+ if ($serverdata['platform'] == 'diaspora') {
$serverdata['network'] = Protocol::DIASPORA;
- } elseif ($serverdata['platform'] == 'Friendica') {
+ } elseif ($serverdata['platform'] == 'friendica') {
$serverdata['network'] = Protocol::DFRN;
} elseif ($serverdata['platform'] == 'hubzilla') {
$serverdata['network'] = Protocol::ZOT;
}
/**
- * @brief Detect server type by using the nodeinfo data
+ * Detect server type by using the nodeinfo data
*
- * @param string $url address of the server
+ * @param string $url address of the server
+ * @param CurlResult $curlResult
* @return array Server data
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function fetchNodeinfo($url, $curlResult)
+ private static function fetchNodeinfo(string $url, CurlResult $curlResult)
{
+ if (!$curlResult->isSuccess()) {
+ return [];
+ }
+
$nodeinfo = json_decode($curlResult->getBody(), true);
if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
}
/**
- * @brief Parses Nodeinfo 1
+ * Parses Nodeinfo 1
*
* @param string $nodeinfo_url address of the nodeinfo path
* @return array Server data
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function parseNodeinfo1($nodeinfo_url)
+ private static function parseNodeinfo1(string $nodeinfo_url)
{
$curlResult = Network::curl($nodeinfo_url);
if (!$curlResult->isSuccess()) {
- return false;
+ return [];
}
$nodeinfo = json_decode($curlResult->getBody(), true);
if (!is_array($nodeinfo)) {
- return false;
+ return [];
}
$server = [];
if (is_array($nodeinfo['software'])) {
if (!empty($nodeinfo['software']['name'])) {
- $server['platform'] = $nodeinfo['software']['name'];
+ $server['platform'] = strtolower($nodeinfo['software']['name']);
}
if (!empty($nodeinfo['software']['version'])) {
}
}
- if (!$server) {
- return false;
+ if (empty($server)) {
+ return [];
}
return $server;
}
/**
- * @brief Parses Nodeinfo 2
+ * Parses Nodeinfo 2
*
* @param string $nodeinfo_url address of the nodeinfo path
* @return array Server data
* @throws \Friendica\Network\HTTPException\InternalServerErrorException
*/
- private static function parseNodeinfo2($nodeinfo_url)
+ private static function parseNodeinfo2(string $nodeinfo_url)
{
$curlResult = Network::curl($nodeinfo_url);
if (!$curlResult->isSuccess()) {
- return false;
+ return [];
}
$nodeinfo = json_decode($curlResult->getBody(), true);
if (!is_array($nodeinfo)) {
- return false;
+ return [];
}
$server = [];
if (is_array($nodeinfo['software'])) {
if (!empty($nodeinfo['software']['name'])) {
- $server['platform'] = $nodeinfo['software']['name'];
+ $server['platform'] = strtolower($nodeinfo['software']['name']);
}
if (!empty($nodeinfo['software']['version'])) {
$protocols[$protocol] = true;
}
- if (!empty($protocols['friendica'])) {
+ if (!empty($protocols['dfrn'])) {
$server['network'] = Protocol::DFRN;
} elseif (!empty($protocols['activitypub'])) {
$server['network'] = Protocol::ACTIVITYPUB;
}
if (empty($server)) {
- return false;
+ return [];
}
return $server;
}
- private static function fetchSiteinfo($url, $serverdata)
+ /**
+ * Fetch server information from a 'siteinfo.json' file on the given server
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function fetchSiteinfo(string $url, array $serverdata)
{
$curlResult = Network::curl($url . '/siteinfo.json');
if (!$curlResult->isSuccess()) {
}
if (!empty($data['url'])) {
- $serverdata['platform'] = $data['platform'];
+ $serverdata['platform'] = strtolower($data['platform']);
$serverdata['version'] = $data['version'];
}
return $serverdata;
}
- private static function validHostMeta($url)
+ /**
+ * Checks if the server contains a valid host meta file
+ *
+ * @param string $url URL of the given server
+ *
+ * @return boolean 'true' if the server seems to be vital
+ */
+ private static function validHostMeta(string $url)
{
- $xrd_timeout = Config::get('system', 'xrd_timeout');
+ $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
$curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
if (!$curlResult->isSuccess()) {
return false;
}
- $xrd = XML::parseString($curlResult->getBody(), false);
+ $xrd = XML::parseString($curlResult->getBody());
if (!is_object($xrd)) {
return false;
}
$valid = false;
foreach ($elements['xrd']['link'] as $link) {
- if (empty($link['rel']) || empty($link['type']) || empty($link['template'])) {
+ // When there is more than a single "link" element, the array looks slightly different
+ if (!empty($link['@attributes'])) {
+ $link = $link['@attributes'];
+ }
+
+ if (empty($link['rel']) || empty($link['template'])) {
continue;
}
- if ($link['type'] == 'application/xrd+xml') {
+ if ($link['rel'] == 'lrdd') {
// When the webfinger host is the same like the system host, it should be ok.
$valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
}
return $valid;
}
- private static function checkPoCo($url, $serverdata)
+ /**
+ * Detect the network of the given server via their known contacts
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function detectNetworkViaContacts(string $url, array $serverdata)
+ {
+ $contacts = [];
+
+ $gcontacts = DBA::select('gcontact', ['url', 'nurl'], ['server_url' => [$url, $serverdata['nurl']]]);
+ while ($gcontact = DBA::fetch($gcontacts)) {
+ $contacts[$gcontact['nurl']] = $gcontact['url'];
+ }
+ DBA::close($gcontacts);
+
+ $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
+ while ($apcontact = DBA::fetch($apcontacts)) {
+ $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
+ }
+ DBA::close($apcontacts);
+
+ $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
+ while ($pcontact = DBA::fetch($pcontacts)) {
+ $contacts[$pcontact['nurl']] = $pcontact['url'];
+ }
+ DBA::close($pcontacts);
+
+ if (empty($contacts)) {
+ return $serverdata;
+ }
+
+ foreach ($contacts as $contact) {
+ $probed = Probe::uri($contact);
+ if (in_array($probed['network'], Protocol::FEDERATED)) {
+ $serverdata['network'] = $probed['network'];
+ break;
+ }
+ }
+
+ $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
+
+ return $serverdata;
+ }
+
+ /**
+ * Checks if the given server does have a '/poco' endpoint.
+ * This is used for the 'PortableContact' functionality,
+ * which is used by both Friendica and Hubzilla.
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function checkPoCo(string $url, array $serverdata)
{
+ $serverdata['poco'] = '';
+
$curlResult = Network::curl($url. '/poco');
if (!$curlResult->isSuccess()) {
return $serverdata;
if (!empty($data['totalResults'])) {
$registeredUsers = $serverdata['registered-users'] ?? 0;
$serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
+ $serverdata['directory-type'] = self::DT_POCO;
$serverdata['poco'] = $url . '/poco';
- } else {
- $serverdata['poco'] = '';
}
return $serverdata;
}
- private static function detectNextcloud($url, $serverdata)
+ /**
+ * Checks if the given server does have a Mastodon style directory endpoint.
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ public static function checkMastodonDirectory(string $url, array $serverdata)
+ {
+ $curlResult = Network::curl($url . '/api/v1/directory?limit=1');
+ if (!$curlResult->isSuccess()) {
+ return $serverdata;
+ }
+
+ $data = json_decode($curlResult->getBody(), true);
+ if (empty($data)) {
+ return $serverdata;
+ }
+
+ if (count($data) == 1) {
+ $serverdata['directory-type'] = self::DT_MASTODON;
+ }
+
+ return $serverdata;
+ }
+
+ /**
+ * Detects the version number of a given server when it was a NextCloud installation
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function detectNextcloud(string $url, array $serverdata)
{
$curlResult = Network::curl($url . '/status.php');
return $serverdata;
}
- private static function detectMastodonAlikes($url, $serverdata)
+ /**
+ * Detects data from a given server url if it was a mastodon alike system
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function detectMastodonAlikes(string $url, array $serverdata)
{
$curlResult = Network::curl($url . '/api/v1/instance');
if (!empty($data['version'])) {
$serverdata['platform'] = 'mastodon';
- $serverdata['version'] = defaults($data, 'version', '');
+ $serverdata['version'] = $data['version'] ?? '';
$serverdata['network'] = Protocol::ACTIVITYPUB;
}
$serverdata['site_name'] = $data['title'];
}
+ if (!empty($data['title']) && empty($serverdata['platform']) && empty($serverdata['network'])) {
+ $serverdata['platform'] = 'mastodon';
+ $serverdata['network'] = Protocol::ACTIVITYPUB;
+ }
+
if (!empty($data['description'])) {
$serverdata['info'] = trim($data['description']);
}
}
if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
- $serverdata['platform'] = $matches[1];
+ $serverdata['platform'] = strtolower($matches[1]);
$serverdata['version'] = $matches[2];
}
- if (!empty($serverdata['version']) && strstr($serverdata['version'], 'Pleroma')) {
+ if (!empty($serverdata['version']) && strstr(strtolower($serverdata['version']), 'pleroma')) {
+ $serverdata['platform'] = 'pleroma';
+ $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
+ }
+
+ if (!empty($serverdata['platform']) && strstr($serverdata['platform'], 'pleroma')) {
+ $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['platform']));
$serverdata['platform'] = 'pleroma';
- $serverdata['version'] = trim(str_replace('Pleroma', '', $serverdata['version']));
}
return $serverdata;
}
- private static function detectHubzilla($url, $serverdata)
+ /**
+ * Detects data from typical Hubzilla endpoints
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function detectHubzilla(string $url, array $serverdata)
{
$curlResult = Network::curl($url . '/api/statusnet/config.json');
if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
}
if (!empty($data['site']['platform'])) {
- $serverdata['platform'] = $data['site']['platform']['PLATFORM_NAME'];
+ $serverdata['platform'] = strtolower($data['site']['platform']['PLATFORM_NAME']);
$serverdata['version'] = $data['site']['platform']['STD_VERSION'];
$serverdata['network'] = Protocol::ZOT;
}
if (!empty($data['site']['hubzilla'])) {
- $serverdata['platform'] = $data['site']['hubzilla']['PLATFORM_NAME'];
+ $serverdata['platform'] = strtolower($data['site']['hubzilla']['PLATFORM_NAME']);
$serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
$serverdata['network'] = Protocol::ZOT;
}
if (!empty($data['site']['redmatrix'])) {
if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
- $serverdata['platform'] = $data['site']['redmatrix']['PLATFORM_NAME'];
+ $serverdata['platform'] = strtolower($data['site']['redmatrix']['PLATFORM_NAME']);
} elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
- $serverdata['platform'] = $data['site']['redmatrix']['RED_PLATFORM'];
+ $serverdata['platform'] = strtolower($data['site']['redmatrix']['RED_PLATFORM']);
}
$serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
return $serverdata;
}
+ /**
+ * Converts input value to a boolean value
+ *
+ * @param string|integer $val
+ *
+ * @return boolean
+ */
private static function toBoolean($val)
{
if (($val == 'true') || ($val == 1)) {
return $val;
}
- private static function detectGNUSocial($url, $serverdata)
+ /**
+ * Detect if the URL belongs to a GNU Social server
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function detectGNUSocial(string $url, array $serverdata)
{
- $curlResult = Network::curl($url . '/api/statusnet/version.json');
-
+ // Test for GNU Social
+ $curlResult = Network::curl($url . '/api/gnusocial/version.json');
if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
- $serverdata['platform'] = 'StatusNet';
+ $serverdata['platform'] = 'gnusocial';
// Remove junk that some GNU Social servers return
- $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
+ $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
+ $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
$serverdata['version'] = trim($serverdata['version'], '"');
$serverdata['network'] = Protocol::OSTATUS;
+ return $serverdata;
}
- // Test for GNU Social
- $curlResult = Network::curl($url . '/api/gnusocial/version.json');
-
+ // Test for Statusnet
+ $curlResult = Network::curl($url . '/api/statusnet/version.json');
if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
- $serverdata['platform'] = 'GNU Social';
+
// Remove junk that some GNU Social servers return
- $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
+ $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
+ $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
$serverdata['version'] = trim($serverdata['version'], '"');
- $serverdata['network'] = Protocol::OSTATUS;
+
+ if (!empty($serverdata['version']) && strtolower(substr($serverdata['version'], 0, 7)) == 'pleroma') {
+ $serverdata['platform'] = 'pleroma';
+ $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
+ $serverdata['network'] = Protocol::ACTIVITYPUB;
+ } else {
+ $serverdata['platform'] = 'statusnet';
+ $serverdata['network'] = Protocol::OSTATUS;
+ }
}
return $serverdata;
}
- private static function detectFriendica($url, $serverdata)
+ /**
+ * Detect if the URL belongs to a Friendica server
+ *
+ * @param string $url URL of the given server
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function detectFriendica(string $url, array $serverdata)
{
$curlResult = Network::curl($url . '/friendica/json');
if (!$curlResult->isSuccess()) {
$serverdata['info'] = trim($data['info']);
}
- $register_policy = defaults($data, 'register_policy', 'REGISTER_CLOSED');
+ $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
switch ($register_policy) {
case 'REGISTER_OPEN':
$serverdata['register_policy'] = Register::OPEN;
break;
}
- $serverdata['platform'] = defaults($data, 'platform', '');
+ $serverdata['platform'] = strtolower($data['platform'] ?? '');
return $serverdata;
}
- private static function analyseRootBody($curlResult, $serverdata)
+ /**
+ * Analyses the landing page of a given server for hints about type and system of that server
+ *
+ * @param object $curlResult result of curl execution
+ * @param array $serverdata array with server data
+ * @param string $url Server URL
+ *
+ * @return array server data
+ */
+ private static function analyseRootBody($curlResult, array $serverdata, string $url)
{
$doc = new DOMDocument();
@$doc->loadHTML($curlResult->getBody());
$attr = [];
if ($node->attributes->length) {
foreach ($node->attributes as $attribute) {
- $attribute->value = trim($attribute->value);
- if (empty($attribute->value)) {
+ $value = trim($attribute->value);
+ if (empty($value)) {
continue;
}
- $attr[$attribute->name] = $attribute->value;
+ $attr[$attribute->name] = $value;
}
if (empty($attr['name']) || empty($attr['content'])) {
}
if ($attr['name'] == 'application-name') {
- $serverdata['platform'] = $attr['content'];
+ $serverdata['platform'] = strtolower($attr['content']);
if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
$serverdata['network'] = Protocol::ACTIVITYPUB;
}
}
-
- if ($attr['name'] == 'generator') {
- $serverdata['platform'] = $attr['content'];
-
+ if (($attr['name'] == 'generator') && (empty($serverdata['platform']) || (substr(strtolower($attr['content']), 0, 9) == 'wordpress'))) {
+ $serverdata['platform'] = strtolower($attr['content']);
$version_part = explode(' ', $attr['content']);
if (count($version_part) == 2) {
if (in_array($version_part[0], ['WordPress'])) {
- $serverdata['platform'] = $version_part[0];
+ $serverdata['platform'] = strtolower($version_part[0]);
$serverdata['version'] = $version_part[1];
- $serverdata['network'] = Protocol::ACTIVITYPUB;
+
+ // We still do need a reliable test if some AP plugin is activated
+ if (DBA::exists('apcontact', ['baseurl' => $url])) {
+ $serverdata['network'] = Protocol::ACTIVITYPUB;
+ } else {
+ $serverdata['network'] = Protocol::FEED;
+ }
}
if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
- $serverdata['platform'] = $version_part[0];
+ $serverdata['platform'] = strtolower($version_part[0]);
$serverdata['version'] = $version_part[1];
$serverdata['network'] = Protocol::DFRN;
}
$attr = [];
if ($node->attributes->length) {
foreach ($node->attributes as $attribute) {
- $attribute->value = trim($attribute->value);
- if (empty($attribute->value)) {
+ $value = trim($attribute->value);
+ if (empty($value)) {
continue;
}
- $attr[$attribute->name] = $attribute->value;
+ $attr[$attribute->name] = $value;
}
if (empty($attr['property']) || empty($attr['content'])) {
}
if ($attr['property'] == 'og:platform') {
- $serverdata['platform'] = $attr['content'];
+ $serverdata['platform'] = strtolower($attr['content']);
if (in_array($attr['content'], ['PeerTube'])) {
$serverdata['network'] = Protocol::ACTIVITYPUB;
}
if ($attr['property'] == 'generator') {
- $serverdata['platform'] = $attr['content'];
+ $serverdata['platform'] = strtolower($attr['content']);
if (in_array($attr['content'], ['hubzilla'])) {
// We later check which compatible protocol modules are loaded.
return $serverdata;
}
- private static function analyseRootHeader($curlResult, $serverdata)
+ /**
+ * Analyses the header data of a given server for hints about type and system of that server
+ *
+ * @param object $curlResult result of curl execution
+ * @param array $serverdata array with server data
+ *
+ * @return array server data
+ */
+ private static function analyseRootHeader($curlResult, array $serverdata)
{
if ($curlResult->getHeader('server') == 'Mastodon') {
$serverdata['platform'] = 'mastodon';
$serverdata['platform'] = 'diaspora';
$serverdata['network'] = $network = Protocol::DIASPORA;
$serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
-
} elseif ($curlResult->inHeader('x-friendica-version')) {
$serverdata['platform'] = 'friendica';
$serverdata['network'] = $network = Protocol::DFRN;
}
return $serverdata;
}
+
+ /**
+ * Test if the body contains valid content
+ *
+ * @param string $body
+ * @return boolean
+ */
+ private static function invalidBody(string $body)
+ {
+ // Currently we only test for a HTML element.
+ // Possibly we enhance this in the future.
+ return !strpos($body, '>');
+ }
+
+ /**
+ * Update the user directory of a given gserver record
+ *
+ * @param array $gserver gserver record
+ */
+ public static function updateDirectory(array $gserver)
+ {
+ /// @todo Add Mastodon API directory
+
+ if (!empty($gserver['poco'])) {
+ PortableContact::discoverSingleServer($gserver['id']);
+ }
+ }
+
+ /**
+ * Update GServer entries
+ */
+ public static function discover()
+ {
+ // Update the server list
+ self::discoverFederation();
+
+ $no_of_queries = 5;
+
+ $requery_days = intval(DI::config()->get('system', 'poco_requery_days'));
+
+ if ($requery_days == 0) {
+ $requery_days = 7;
+ }
+
+ $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
+
+ $gservers = DBA::p("SELECT `id`, `url`, `nurl`, `network`, `poco`
+ FROM `gserver`
+ WHERE `last_contact` >= `last_failure`
+ AND `poco` != ''
+ AND `last_poco_query` < ?
+ ORDER BY RAND()", $last_update
+ );
+
+ while ($gserver = DBA::fetch($gservers)) {
+ if (!GServer::check($gserver['url'], $gserver['network'])) {
+ // The server is not reachable? Okay, then we will try it later
+ $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
+ DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
+ continue;
+ }
+
+ Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
+ Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
+
+ if (--$no_of_queries == 0) {
+ break;
+ }
+ }
+
+ DBA::close($gservers);
+ }
+
+ /**
+ * Discover federated servers
+ */
+ private static function discoverFederation()
+ {
+ $last = DI::config()->get('poco', 'last_federation_discovery');
+
+ if ($last) {
+ $next = $last + (24 * 60 * 60);
+
+ if ($next > time()) {
+ return;
+ }
+ }
+
+ // Discover federated servers
+ $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
+
+ if (!empty($curlResult)) {
+ $servers = json_decode($curlResult, true);
+
+ if (!empty($servers['pods'])) {
+ foreach ($servers['pods'] as $server) {
+ // Using "only_nodeinfo" since servers that are listed on that page should always have it.
+ Worker::add(PRIORITY_LOW, 'UpdateGServer', 'https://' . $server['host'], true);
+ }
+ }
+ }
+
+ // Disvover Mastodon servers
+ $accesstoken = DI::config()->get('system', 'instances_social_key');
+
+ if (!empty($accesstoken)) {
+ $api = 'https://instances.social/api/1.0/instances/list?count=0';
+ $header = ['Authorization: Bearer '.$accesstoken];
+ $curlResult = Network::curl($api, false, ['headers' => $header]);
+
+ if ($curlResult->isSuccess()) {
+ $servers = json_decode($curlResult->getBody(), true);
+
+ foreach ($servers['instances'] as $server) {
+ $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
+ Worker::add(PRIORITY_LOW, 'UpdateGServer', $url);
+ }
+ }
+ }
+
+ DI::config()->set('poco', 'last_federation_discovery', time());
+ }
}