3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
27 use Friendica\Core\Logger;
28 use Friendica\Core\Protocol;
29 use Friendica\Core\System;
30 use Friendica\Core\Worker;
31 use Friendica\Database\Database;
32 use Friendica\Database\DBA;
34 use Friendica\Module\Register;
35 use Friendica\Network\HTTPClient\Client\HttpClientOptions;
36 use Friendica\Network\HTTPClient\Capability\ICanHandleHttpResponses;
37 use Friendica\Protocol\Relay;
38 use Friendica\Util\DateTimeFormat;
39 use Friendica\Util\Network;
40 use Friendica\Util\Strings;
41 use Friendica\Util\XML;
44 * This class handles GServer related functions
51 const DT_MASTODON = 2;
53 // Methods to detect server types
55 // Non endpoint specific methods
56 const DETECT_MANUAL = 0;
57 const DETECT_HEADER = 1;
58 const DETECT_BODY = 2;
60 // Implementation specific endpoints
61 const DETECT_FRIENDIKA = 10;
62 const DETECT_FRIENDICA = 11;
63 const DETECT_STATUSNET = 12;
64 const DETECT_GNUSOCIAL = 13;
65 const DETECT_CONFIG_JSON = 14; // Statusnet, GNU Social, Older Hubzilla/Redmatrix
66 const DETECT_SITEINFO_JSON = 15; // Newer Hubzilla
67 const DETECT_MASTODON_API = 16;
68 const DETECT_STATUS_PHP = 17; // Nextcloud
69 const DETECT_V1_CONFIG = 18;
70 const DETECT_PUMPIO = 19;
72 // Standardized endpoints
73 const DETECT_STATISTICS_JSON = 100;
74 const DETECT_NODEINFO_1 = 101;
75 const DETECT_NODEINFO_2 = 102;
78 * Check for the existance of a server and adds it in the background if not existant
81 * @param boolean $only_nodeinfo
84 public static function add(string $url, bool $only_nodeinfo = false)
86 if (self::getID($url, false)) {
90 Worker::add(PRIORITY_LOW, 'UpdateGServer', $url, $only_nodeinfo);
94 * Get the ID for the given server URL
97 * @param boolean $no_check Don't check if the server hadn't been found
98 * @return int gserver id
100 public static function getID(string $url, bool $no_check = false)
106 $url = self::cleanURL($url);
108 $gserver = DBA::selectFirst('gserver', ['id'], ['nurl' => Strings::normaliseLink($url)]);
109 if (DBA::isResult($gserver)) {
110 Logger::info('Got ID for URL', ['id' => $gserver['id'], 'url' => $url, 'callstack' => System::callstack(20)]);
111 return $gserver['id'];
114 if ($no_check || !self::check($url)) {
118 return self::getID($url, true);
122 * Retrieves all the servers which base domain are matching the provided domain pattern
124 * The pattern is a simple fnmatch() pattern with ? for single wildcard and * for multiple wildcard
126 * @param string $pattern
130 public static function listByDomainPattern(string $pattern): array
132 $likePattern = 'http://' . strtr($pattern, ['_' => '\_', '%' => '\%', '?' => '_', '*' => '%']);
134 // The SUBSTRING_INDEX returns everything before the eventual third /, which effectively trims an
135 // eventual server path and keep only the server domain which we're matching against the pattern.
136 $sql = "SELECT `gserver`.*, COUNT(*) AS `contacts`
138 LEFT JOIN `contact` ON `gserver`.`id` = `contact`.`gsid`
139 WHERE SUBSTRING_INDEX(`gserver`.`nurl`, '/', 3) LIKE ?
140 AND NOT `gserver`.`failed`
141 GROUP BY `gserver`.`id`";
143 $stmt = DI::dba()->p($sql, $likePattern);
145 return DI::dba()->toArray($stmt);
149 * Checks if the given server is reachable
151 * @param string $profile URL of the given profile
152 * @param string $server URL of the given server (If empty, taken from profile)
153 * @param string $network Network value that is used, when detection failed
154 * @param boolean $force Force an update.
156 * @return boolean 'true' if server seems vital
158 public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false)
161 $contact = Contact::getByURL($profile, null, ['baseurl']);
162 if (!empty($contact['baseurl'])) {
163 $server = $contact['baseurl'];
171 return self::check($server, $network, $force);
174 public static function getNextUpdateDate(bool $success, string $created = '', string $last_contact = '')
176 // On successful contact process check again next week
178 return DateTimeFormat::utc('now +7 day');
181 $now = strtotime(DateTimeFormat::utcNow());
183 if ($created > $last_contact) {
184 $contact_time = strtotime($created);
186 $contact_time = strtotime($last_contact);
189 // If the last contact was less than 6 hours before then try again in 6 hours
190 if (($now - $contact_time) < (60 * 60 * 6)) {
191 return DateTimeFormat::utc('now +6 hour');
194 // If the last contact was less than 12 hours before then try again in 12 hours
195 if (($now - $contact_time) < (60 * 60 * 12)) {
196 return DateTimeFormat::utc('now +12 hour');
199 // If the last contact was less than 24 hours before then try tomorrow again
200 if (($now - $contact_time) < (60 * 60 * 24)) {
201 return DateTimeFormat::utc('now +1 day');
204 // If the last contact was less than a week before then try again in a week
205 if (($now - $contact_time) < (60 * 60 * 24 * 7)) {
206 return DateTimeFormat::utc('now +1 week');
209 // If the last contact was less than two weeks before then try again in two week
210 if (($now - $contact_time) < (60 * 60 * 24 * 14)) {
211 return DateTimeFormat::utc('now +2 week');
214 // If the last contact was less than a month before then try again in a month
215 if (($now - $contact_time) < (60 * 60 * 24 * 30)) {
216 return DateTimeFormat::utc('now +1 month');
219 // The system hadn't been successul contacted for more than a month, so try again in three months
220 return DateTimeFormat::utc('now +3 month');
224 * Checks the state of the given server.
226 * @param string $server_url URL of the given server
227 * @param string $network Network value that is used, when detection failed
228 * @param boolean $force Force an update.
229 * @param boolean $only_nodeinfo Only use nodeinfo for server detection
231 * @return boolean 'true' if server seems vital
233 public static function check(string $server_url, string $network = '', bool $force = false, bool $only_nodeinfo = false)
235 $server_url = self::cleanURL($server_url);
236 if ($server_url == '') {
240 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
241 if (DBA::isResult($gserver)) {
242 if ($gserver['created'] <= DBA::NULL_DATETIME) {
243 $fields = ['created' => DateTimeFormat::utcNow()];
244 $condition = ['nurl' => Strings::normaliseLink($server_url)];
245 DBA::update('gserver', $fields, $condition);
248 if (!$force && (strtotime($gserver['next_contact']) > time())) {
249 Logger::info('No update needed', ['server' => $server_url]);
250 return (!$gserver['failed']);
252 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force]);
254 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
257 return self::detect($server_url, $network, $only_nodeinfo);
261 * Set failed server status
265 public static function setFailure(string $url)
267 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($url)]);
268 if (DBA::isResult($gserver)) {
269 $next_update = self::getNextUpdateDate(false, $gserver['created'], $gserver['last_contact']);
270 DBA::update('gserver', ['failed' => true, 'last_failure' => DateTimeFormat::utcNow(),
271 'next_contact' => $next_update, 'detection-method' => null],
272 ['nurl' => Strings::normaliseLink($url)]);
273 Logger::info('Set failed status for existing server', ['url' => $url]);
276 DBA::insert('gserver', ['url' => $url, 'nurl' => Strings::normaliseLink($url),
277 'network' => Protocol::PHANTOM, 'created' => DateTimeFormat::utcNow(),
278 'failed' => true, 'last_failure' => DateTimeFormat::utcNow()]);
279 Logger::info('Set failed status for new server', ['url' => $url]);
283 * Remove unwanted content from the given URL
286 * @return string cleaned URL
288 public static function cleanURL(string $url)
290 $url = trim($url, '/');
291 $url = str_replace('/index.php', '', $url);
293 $urlparts = parse_url($url);
294 unset($urlparts['user']);
295 unset($urlparts['pass']);
296 unset($urlparts['query']);
297 unset($urlparts['fragment']);
298 return Network::unparseURL($urlparts);
302 * Return the base URL
305 * @return string base URL
307 private static function getBaseURL(string $url)
309 $urlparts = parse_url(self::cleanURL($url));
310 unset($urlparts['path']);
311 return Network::unparseURL($urlparts);
315 * Detect server data (type, protocol, version number, ...)
316 * The detected data is then updated or inserted in the gserver table.
318 * @param string $url URL of the given server
319 * @param string $network Network value that is used, when detection failed
320 * @param boolean $only_nodeinfo Only use nodeinfo for server detection
322 * @return boolean 'true' if server could be detected
324 public static function detect(string $url, string $network = '', bool $only_nodeinfo = false)
326 Logger::info('Detect server type', ['server' => $url]);
327 $serverdata = ['detection-method' => self::DETECT_MANUAL];
329 $original_url = $url;
331 // Remove URL content that is not supposed to exist for a server url
332 $url = self::cleanURL($url);
335 $baseurl = self::getBaseURL($url);
337 // If the URL missmatches, then we mark the old entry as failure
338 if ($url != $original_url) {
339 /// @todo What to do with "next_contact" here?
340 DBA::update('gserver', ['failed' => true, 'last_failure' => DateTimeFormat::utcNow()],
341 ['nurl' => Strings::normaliseLink($original_url)]);
344 // When a nodeinfo is present, we don't need to dig further
345 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
346 $curlResult = DI::httpClient()->get($url . '/.well-known/nodeinfo', [HttpClientOptions::TIMEOUT => $xrd_timeout]);
347 if ($curlResult->isTimeout()) {
348 self::setFailure($url);
352 // On a redirect follow the new host but mark the old one as failure
353 if ($curlResult->isSuccess() && !empty($curlResult->getRedirectUrl()) && (parse_url($url, PHP_URL_HOST) != parse_url($curlResult->getRedirectUrl(), PHP_URL_HOST))) {
354 $curlResult = DI::httpClient()->get($url, [HttpClientOptions::TIMEOUT => $xrd_timeout]);
355 if (!empty($curlResult->getRedirectUrl()) && parse_url($url, PHP_URL_HOST) != parse_url($curlResult->getRedirectUrl(), PHP_URL_HOST)) {
356 Logger::info('Found redirect. Mark old entry as failure', ['old' => $url, 'new' => $curlResult->getRedirectUrl()]);
357 self::setFailure($url);
358 self::detect($curlResult->getRedirectUrl(), $network, $only_nodeinfo);
363 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
364 if ($only_nodeinfo && empty($nodeinfo)) {
365 Logger::info('Invalid nodeinfo in nodeinfo-mode, server is marked as failure', ['url' => $url]);
366 self::setFailure($url);
370 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
371 if (empty($nodeinfo)) {
372 $nodeinfo = self::fetchStatistics($url);
375 // If that didn't work out well, we use some protocol specific endpoints
376 // For Friendica and Zot based networks we have to dive deeper to reveal more details
377 if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
378 if (!empty($nodeinfo['detection-method'])) {
379 $serverdata['detection-method'] = $nodeinfo['detection-method'];
381 foreach (['registered-users', 'active_users_monthly', 'active-halfyear-users', 'local-posts'] as $field) {
382 if (!empty($nodeinfo[$field])) {
383 $serverdata[$field] = $nodeinfo[$field];
388 // Fetch the landing page, possibly it reveals some data
389 if (empty($nodeinfo['network'])) {
390 if ($baseurl == $url) {
391 $basedata = $serverdata;
393 $basedata = ['detection-method' => self::DETECT_MANUAL];
396 $curlResult = DI::httpClient()->get($baseurl, [HttpClientOptions::TIMEOUT => $xrd_timeout]);
397 if ($curlResult->isSuccess()) {
398 if (!empty($curlResult->getRedirectUrl()) && (parse_url($baseurl, PHP_URL_HOST) != parse_url($curlResult->getRedirectUrl(), PHP_URL_HOST))) {
399 Logger::info('Found redirect. Mark old entry as failure', ['old' => $url, 'new' => $curlResult->getRedirectUrl()]);
400 self::setFailure($url);
401 self::detect($curlResult->getRedirectUrl(), $network, $only_nodeinfo);
405 $basedata = self::analyseRootHeader($curlResult, $basedata);
406 $basedata = self::analyseRootBody($curlResult, $basedata, $baseurl);
409 if (!$curlResult->isSuccess() || empty($curlResult->getBody()) || self::invalidBody($curlResult->getBody())) {
410 self::setFailure($url);
414 if ($baseurl == $url) {
415 $serverdata = $basedata;
417 // When the base path doesn't seem to contain a social network we try the complete path.
418 // Most detectable system have to be installed in the root directory.
419 // We checked the base to avoid false positives.
420 $curlResult = DI::httpClient()->get($url, [HttpClientOptions::TIMEOUT => $xrd_timeout]);
421 if ($curlResult->isSuccess()) {
422 $urldata = self::analyseRootHeader($curlResult, $serverdata);
423 $urldata = self::analyseRootBody($curlResult, $urldata, $url);
425 $comparebase = $basedata;
426 unset($comparebase['info']);
427 unset($comparebase['site_name']);
428 $compareurl = $urldata;
429 unset($compareurl['info']);
430 unset($compareurl['site_name']);
432 // We assume that no one will install the identical system in the root and a subfolder
433 if (!empty(array_diff($comparebase, $compareurl))) {
434 $serverdata = $urldata;
440 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
441 $serverdata = self::detectMastodonAlikes($url, $serverdata);
444 // All following checks are done for systems that always have got a "host-meta" endpoint.
445 // With this check we don't have to waste time and ressources for dead systems.
446 // Also this hopefully prevents us from receiving abuse messages.
447 if (empty($serverdata['network']) && !self::validHostMeta($url)) {
448 self::setFailure($url);
452 if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
453 $serverdata = self::detectFriendica($url, $serverdata);
456 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
457 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
458 $serverdata = self::fetchSiteinfo($url, $serverdata);
461 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
462 if (empty($serverdata['network'])) {
463 $serverdata = self::detectHubzilla($url, $serverdata);
466 if (empty($serverdata['network']) || in_array($serverdata['detection-method'], [self::DETECT_MANUAL, self::DETECT_BODY])) {
467 $serverdata = self::detectPeertube($url, $serverdata);
470 if (empty($serverdata['network'])) {
471 $serverdata = self::detectNextcloud($url, $serverdata);
474 if (empty($serverdata['network'])) {
475 $serverdata = self::detectGNUSocial($url, $serverdata);
478 if (empty($serverdata['network'])) {
479 $serverdata = self::detectPumpIO($url, $serverdata);
482 $serverdata = array_merge($nodeinfo, $serverdata);
484 $serverdata = $nodeinfo;
487 // Detect the directory type
488 $serverdata['directory-type'] = self::DT_NONE;
489 $serverdata = self::checkPoCo($url, $serverdata);
490 $serverdata = self::checkMastodonDirectory($url, $serverdata);
492 // We can't detect the network type. Possibly it is some system that we don't know yet
493 if (empty($serverdata['network'])) {
494 $serverdata['network'] = Protocol::PHANTOM;
497 // When we hadn't been able to detect the network type, we use the hint from the parameter
498 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
499 $serverdata['network'] = $network;
502 $serverdata['url'] = $url;
503 $serverdata['nurl'] = Strings::normaliseLink($url);
505 if (in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED])) {
506 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
509 if ($serverdata['network'] == Protocol::ACTIVITYPUB) {
510 $serverdata = self::fetchWeeklyUsage($url, $serverdata);
513 $serverdata['registered-users'] = $serverdata['registered-users'] ?? 0;
515 // On an active server there has to be at least a single user
516 if (!in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED]) && ($serverdata['registered-users'] == 0)) {
517 $serverdata['registered-users'] = 1;
518 } elseif (in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED])) {
519 $serverdata['registered-users'] = 0;
522 $serverdata['next_contact'] = self::getNextUpdateDate(true);
524 $serverdata['last_contact'] = DateTimeFormat::utcNow();
525 $serverdata['failed'] = false;
527 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
528 if (!DBA::isResult($gserver)) {
529 $serverdata['created'] = DateTimeFormat::utcNow();
530 $ret = DBA::insert('gserver', $serverdata);
531 $id = DBA::lastInsertId();
533 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
534 $gserver = DBA::selectFirst('gserver', ['id'], ['nurl' => $serverdata['nurl']]);
535 if (DBA::isResult($gserver)) {
536 $id = $gserver['id'];
540 // Count the number of known contacts from this server
541 if (!empty($id) && !in_array($serverdata['network'], [Protocol::PHANTOM, Protocol::FEED])) {
542 $apcontacts = DBA::count('apcontact', ['gsid' => $id]);
543 $contacts = DBA::count('contact', ['uid' => 0, 'gsid' => $id, 'failed' => false]);
544 $max_users = max($apcontacts, $contacts);
545 if ($max_users > $serverdata['registered-users']) {
546 Logger::info('Update registered users', ['id' => $id, 'url' => $serverdata['nurl'], 'registered-users' => $max_users]);
547 DBA::update('gserver', ['registered-users' => $max_users], ['id' => $id]);
550 if (empty($serverdata['active-month-users'])) {
551 $contacts = DBA::count('contact', ["`uid` = ? AND `gsid` = ? AND NOT `failed` AND `last-item` > ?", 0, $id, DateTimeFormat::utc('now - 30 days')]);
553 Logger::info('Update monthly users', ['id' => $id, 'url' => $serverdata['nurl'], 'monthly-users' => $contacts]);
554 DBA::update('gserver', ['active-month-users' => $contacts], ['id' => $id]);
558 if (empty($serverdata['active-halfyear-users'])) {
559 $contacts = DBA::count('contact', ["`uid` = ? AND `gsid` = ? AND NOT `failed` AND `last-item` > ?", 0, $id, DateTimeFormat::utc('now - 180 days')]);
561 Logger::info('Update halfyear users', ['id' => $id, 'url' => $serverdata['nurl'], 'halfyear-users' => $contacts]);
562 DBA::update('gserver', ['active-halfyear-users' => $contacts], ['id' => $id]);
567 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
568 self::discoverRelay($url);
575 * Fetch relay data from a given server url
577 * @param string $server_url address of the server
578 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
580 private static function discoverRelay(string $server_url)
582 Logger::info('Discover relay data', ['server' => $server_url]);
584 $curlResult = DI::httpClient()->get($server_url . '/.well-known/x-social-relay');
585 if (!$curlResult->isSuccess()) {
589 $data = json_decode($curlResult->getBody(), true);
590 if (!is_array($data)) {
594 // Sanitize incoming data, see https://github.com/friendica/friendica/issues/8565
595 $data['subscribe'] = (bool)$data['subscribe'] ?? false;
597 if (!$data['subscribe'] || empty($data['scope']) || !in_array(strtolower($data['scope']), ['all', 'tags'])) {
599 $data['subscribe'] = false;
603 $gserver = DBA::selectFirst('gserver', ['id', 'url', 'network', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
604 if (!DBA::isResult($gserver)) {
608 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
609 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
610 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
613 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
615 if ($data['scope'] == 'tags') {
618 foreach ($data['tags'] as $tag) {
619 $tag = mb_strtolower($tag);
620 if (strlen($tag) < 100) {
625 foreach ($tags as $tag) {
626 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], Database::INSERT_IGNORE);
630 // Create or update the relay contact
632 if (isset($data['protocols'])) {
633 if (isset($data['protocols']['diaspora'])) {
634 $fields['network'] = Protocol::DIASPORA;
636 if (isset($data['protocols']['diaspora']['receive'])) {
637 $fields['batch'] = $data['protocols']['diaspora']['receive'];
638 } elseif (is_string($data['protocols']['diaspora'])) {
639 $fields['batch'] = $data['protocols']['diaspora'];
643 if (isset($data['protocols']['dfrn'])) {
644 $fields['network'] = Protocol::DFRN;
646 if (isset($data['protocols']['dfrn']['receive'])) {
647 $fields['batch'] = $data['protocols']['dfrn']['receive'];
648 } elseif (is_string($data['protocols']['dfrn'])) {
649 $fields['batch'] = $data['protocols']['dfrn'];
653 if (isset($data['protocols']['activitypub'])) {
654 $fields['network'] = Protocol::ACTIVITYPUB;
656 if (!empty($data['protocols']['activitypub']['actor'])) {
657 $fields['url'] = $data['protocols']['activitypub']['actor'];
659 if (!empty($data['protocols']['activitypub']['receive'])) {
660 $fields['batch'] = $data['protocols']['activitypub']['receive'];
665 Logger::info('Discovery ended', ['server' => $server_url, 'data' => $fields]);
667 Relay::updateContact($gserver, $fields);
671 * Fetch server data from '/statistics.json' on the given server
673 * @param string $url URL of the given server
675 * @return array server data
677 private static function fetchStatistics(string $url)
679 $curlResult = DI::httpClient()->get($url . '/statistics.json');
680 if (!$curlResult->isSuccess()) {
684 $data = json_decode($curlResult->getBody(), true);
689 $serverdata = ['detection-method' => self::DETECT_STATISTICS_JSON];
691 if (!empty($data['version'])) {
692 $serverdata['version'] = $data['version'];
693 // Version numbers on statistics.json are presented with additional info, e.g.:
694 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
695 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
698 if (!empty($data['name'])) {
699 $serverdata['site_name'] = $data['name'];
702 if (!empty($data['network'])) {
703 $serverdata['platform'] = strtolower($data['network']);
705 if ($serverdata['platform'] == 'diaspora') {
706 $serverdata['network'] = Protocol::DIASPORA;
707 } elseif ($serverdata['platform'] == 'friendica') {
708 $serverdata['network'] = Protocol::DFRN;
709 } elseif ($serverdata['platform'] == 'hubzilla') {
710 $serverdata['network'] = Protocol::ZOT;
711 } elseif ($serverdata['platform'] == 'redmatrix') {
712 $serverdata['network'] = Protocol::ZOT;
716 if (!empty($data['total_users'])) {
717 $serverdata['registered-users'] = max($data['total_users'], 1);
720 if (!empty($data['active_users_monthly'])) {
721 $serverdata['active-month-users'] = max($data['active_users_monthly'], 0);
724 if (!empty($data['active_users_halfyear'])) {
725 $serverdata['active-halfyear-users'] = max($data['active_users_halfyear'], 0);
728 if (!empty($data['local_posts'])) {
729 $serverdata['local-posts'] = max($data['local_posts'], 0);
732 if (!empty($data['registrations_open'])) {
733 $serverdata['register_policy'] = Register::OPEN;
735 $serverdata['register_policy'] = Register::CLOSED;
742 * Detect server type by using the nodeinfo data
744 * @param string $url address of the server
745 * @param ICanHandleHttpResponses $httpResult
747 * @return array Server data
748 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
750 private static function fetchNodeinfo(string $url, ICanHandleHttpResponses $httpResult)
752 if (!$httpResult->isSuccess()) {
756 $nodeinfo = json_decode($httpResult->getBody(), true);
758 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
765 foreach ($nodeinfo['links'] as $link) {
766 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
767 Logger::info('Invalid nodeinfo format', ['url' => $url]);
770 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
771 $nodeinfo1_url = $link['href'];
772 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
773 $nodeinfo2_url = $link['href'];
777 if ($nodeinfo1_url . $nodeinfo2_url == '') {
783 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
784 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
785 $server = self::parseNodeinfo2($nodeinfo2_url);
788 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
789 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
790 $server = self::parseNodeinfo1($nodeinfo1_url);
799 * @param string $nodeinfo_url address of the nodeinfo path
800 * @return array Server data
801 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
803 private static function parseNodeinfo1(string $nodeinfo_url)
805 $curlResult = DI::httpClient()->get($nodeinfo_url);
807 if (!$curlResult->isSuccess()) {
811 $nodeinfo = json_decode($curlResult->getBody(), true);
813 if (!is_array($nodeinfo)) {
817 $server = ['detection-method' => self::DETECT_NODEINFO_1,
818 'register_policy' => Register::CLOSED];
820 if (!empty($nodeinfo['openRegistrations'])) {
821 $server['register_policy'] = Register::OPEN;
824 if (is_array($nodeinfo['software'])) {
825 if (!empty($nodeinfo['software']['name'])) {
826 $server['platform'] = strtolower($nodeinfo['software']['name']);
829 if (!empty($nodeinfo['software']['version'])) {
830 $server['version'] = $nodeinfo['software']['version'];
831 // Version numbers on Nodeinfo are presented with additional info, e.g.:
832 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
833 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
837 if (!empty($nodeinfo['metadata']['nodeName'])) {
838 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
841 if (!empty($nodeinfo['usage']['users']['total'])) {
842 $server['registered-users'] = max($nodeinfo['usage']['users']['total'], 1);
845 if (!empty($nodeinfo['usage']['users']['activeMonth'])) {
846 $server['active-month-users'] = max($nodeinfo['usage']['users']['activeMonth'], 0);
849 if (!empty($nodeinfo['usage']['users']['activeHalfyear'])) {
850 $server['active-halfyear-users'] = max($nodeinfo['usage']['users']['activeHalfyear'], 0);
853 if (!empty($nodeinfo['usage']['localPosts'])) {
854 $server['local-posts'] = max($nodeinfo['usage']['localPosts'], 0);
857 if (!empty($nodeinfo['usage']['localComments'])) {
858 $server['local-comments'] = max($nodeinfo['usage']['localComments'], 0);
861 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
863 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
864 $protocols[$protocol] = true;
867 if (!empty($protocols['friendica'])) {
868 $server['network'] = Protocol::DFRN;
869 } elseif (!empty($protocols['activitypub'])) {
870 $server['network'] = Protocol::ACTIVITYPUB;
871 } elseif (!empty($protocols['diaspora'])) {
872 $server['network'] = Protocol::DIASPORA;
873 } elseif (!empty($protocols['ostatus'])) {
874 $server['network'] = Protocol::OSTATUS;
875 } elseif (!empty($protocols['gnusocial'])) {
876 $server['network'] = Protocol::OSTATUS;
877 } elseif (!empty($protocols['zot'])) {
878 $server['network'] = Protocol::ZOT;
882 if (empty($server)) {
892 * @see https://git.feneas.org/jaywink/nodeinfo2
893 * @param string $nodeinfo_url address of the nodeinfo path
894 * @return array Server data
895 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
897 private static function parseNodeinfo2(string $nodeinfo_url)
899 $curlResult = DI::httpClient()->get($nodeinfo_url);
900 if (!$curlResult->isSuccess()) {
904 $nodeinfo = json_decode($curlResult->getBody(), true);
906 if (!is_array($nodeinfo)) {
910 $server = ['detection-method' => self::DETECT_NODEINFO_2,
911 'register_policy' => Register::CLOSED];
913 if (!empty($nodeinfo['openRegistrations'])) {
914 $server['register_policy'] = Register::OPEN;
917 if (is_array($nodeinfo['software'])) {
918 if (!empty($nodeinfo['software']['name'])) {
919 $server['platform'] = strtolower($nodeinfo['software']['name']);
922 if (!empty($nodeinfo['software']['version'])) {
923 $server['version'] = $nodeinfo['software']['version'];
924 // Version numbers on Nodeinfo are presented with additional info, e.g.:
925 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
926 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
930 if (!empty($nodeinfo['metadata']['nodeName'])) {
931 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
934 if (!empty($nodeinfo['usage']['users']['total'])) {
935 $server['registered-users'] = max($nodeinfo['usage']['users']['total'], 1);
938 if (!empty($nodeinfo['usage']['users']['activeMonth'])) {
939 $server['active-month-users'] = max($nodeinfo['usage']['users']['activeMonth'], 0);
942 if (!empty($nodeinfo['usage']['users']['activeHalfyear'])) {
943 $server['active-halfyear-users'] = max($nodeinfo['usage']['users']['activeHalfyear'], 0);
946 if (!empty($nodeinfo['usage']['localPosts'])) {
947 $server['local-posts'] = max($nodeinfo['usage']['localPosts'], 0);
950 if (!empty($nodeinfo['usage']['localComments'])) {
951 $server['local-comments'] = max($nodeinfo['usage']['localComments'], 0);
954 if (!empty($nodeinfo['protocols'])) {
956 foreach ($nodeinfo['protocols'] as $protocol) {
957 if (is_string($protocol)) {
958 $protocols[$protocol] = true;
962 if (!empty($protocols['dfrn'])) {
963 $server['network'] = Protocol::DFRN;
964 } elseif (!empty($protocols['activitypub'])) {
965 $server['network'] = Protocol::ACTIVITYPUB;
966 } elseif (!empty($protocols['diaspora'])) {
967 $server['network'] = Protocol::DIASPORA;
968 } elseif (!empty($protocols['ostatus'])) {
969 $server['network'] = Protocol::OSTATUS;
970 } elseif (!empty($protocols['gnusocial'])) {
971 $server['network'] = Protocol::OSTATUS;
972 } elseif (!empty($protocols['zot'])) {
973 $server['network'] = Protocol::ZOT;
977 if (empty($server)) {
985 * Fetch server information from a 'siteinfo.json' file on the given server
987 * @param string $url URL of the given server
988 * @param array $serverdata array with server data
990 * @return array server data
992 private static function fetchSiteinfo(string $url, array $serverdata)
994 $curlResult = DI::httpClient()->get($url . '/siteinfo.json');
995 if (!$curlResult->isSuccess()) {
999 $data = json_decode($curlResult->getBody(), true);
1004 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1005 $serverdata['detection-method'] = self::DETECT_SITEINFO_JSON;
1008 if (!empty($data['url'])) {
1009 $serverdata['platform'] = strtolower($data['platform']);
1010 $serverdata['version'] = $data['version'];
1013 if (!empty($data['plugins'])) {
1014 if (in_array('pubcrawl', $data['plugins'])) {
1015 $serverdata['network'] = Protocol::ACTIVITYPUB;
1016 } elseif (in_array('diaspora', $data['plugins'])) {
1017 $serverdata['network'] = Protocol::DIASPORA;
1018 } elseif (in_array('gnusoc', $data['plugins'])) {
1019 $serverdata['network'] = Protocol::OSTATUS;
1021 $serverdata['network'] = Protocol::ZOT;
1025 if (!empty($data['site_name'])) {
1026 $serverdata['site_name'] = $data['site_name'];
1029 if (!empty($data['channels_total'])) {
1030 $serverdata['registered-users'] = max($data['channels_total'], 1);
1033 if (!empty($data['channels_active_monthly'])) {
1034 $serverdata['active-month-users'] = max($data['channels_active_monthly'], 0);
1037 if (!empty($data['channels_active_halfyear'])) {
1038 $serverdata['active-halfyear-users'] = max($data['channels_active_halfyear'], 0);
1041 if (!empty($data['local_posts'])) {
1042 $serverdata['local-posts'] = max($data['local_posts'], 0);
1045 if (!empty($data['local_comments'])) {
1046 $serverdata['local-comments'] = max($data['local_comments'], 0);
1049 if (!empty($data['register_policy'])) {
1050 switch ($data['register_policy']) {
1051 case 'REGISTER_OPEN':
1052 $serverdata['register_policy'] = Register::OPEN;
1055 case 'REGISTER_APPROVE':
1056 $serverdata['register_policy'] = Register::APPROVE;
1059 case 'REGISTER_CLOSED':
1061 $serverdata['register_policy'] = Register::CLOSED;
1070 * Checks if the server contains a valid host meta file
1072 * @param string $url URL of the given server
1074 * @return boolean 'true' if the server seems to be vital
1076 private static function validHostMeta(string $url)
1078 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
1079 $curlResult = DI::httpClient()->get($url . '/.well-known/host-meta', [HttpClientOptions::TIMEOUT => $xrd_timeout]);
1080 if (!$curlResult->isSuccess()) {
1084 $xrd = XML::parseString($curlResult->getBody());
1085 if (!is_object($xrd)) {
1089 $elements = XML::elementToArray($xrd);
1090 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
1095 foreach ($elements['xrd']['link'] as $link) {
1096 // When there is more than a single "link" element, the array looks slightly different
1097 if (!empty($link['@attributes'])) {
1098 $link = $link['@attributes'];
1101 if (empty($link['rel']) || empty($link['template'])) {
1105 if ($link['rel'] == 'lrdd') {
1106 // When the webfinger host is the same like the system host, it should be ok.
1107 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
1115 * Detect the network of the given server via their known contacts
1117 * @param string $url URL of the given server
1118 * @param array $serverdata array with server data
1120 * @return array server data
1122 private static function detectNetworkViaContacts(string $url, array $serverdata)
1126 $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
1127 while ($apcontact = DBA::fetch($apcontacts)) {
1128 $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
1130 DBA::close($apcontacts);
1132 $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
1133 while ($pcontact = DBA::fetch($pcontacts)) {
1134 $contacts[$pcontact['nurl']] = $pcontact['url'];
1136 DBA::close($pcontacts);
1138 if (empty($contacts)) {
1143 foreach ($contacts as $contact) {
1144 $probed = Contact::getByURL($contact, true);
1145 if (!empty($probed) && !$probed['failed'] && in_array($probed['network'], Protocol::FEDERATED)) {
1146 $serverdata['network'] = $probed['network'];
1148 } elseif ((time() - $time) > 10) {
1149 // To reduce the stress on remote systems we probe a maximum of 10 seconds
1158 * Checks if the given server does have a '/poco' endpoint.
1159 * This is used for the 'PortableContact' functionality,
1160 * which is used by both Friendica and Hubzilla.
1162 * @param string $url URL of the given server
1163 * @param array $serverdata array with server data
1165 * @return array server data
1167 private static function checkPoCo(string $url, array $serverdata)
1169 $serverdata['poco'] = '';
1171 $curlResult = DI::httpClient()->get($url . '/poco');
1172 if (!$curlResult->isSuccess()) {
1176 $data = json_decode($curlResult->getBody(), true);
1181 if (!empty($data['totalResults'])) {
1182 $registeredUsers = $serverdata['registered-users'] ?? 0;
1183 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers, 1);
1184 $serverdata['directory-type'] = self::DT_POCO;
1185 $serverdata['poco'] = $url . '/poco';
1192 * Checks if the given server does have a Mastodon style directory endpoint.
1194 * @param string $url URL of the given server
1195 * @param array $serverdata array with server data
1197 * @return array server data
1199 public static function checkMastodonDirectory(string $url, array $serverdata)
1201 $curlResult = DI::httpClient()->get($url . '/api/v1/directory?limit=1');
1202 if (!$curlResult->isSuccess()) {
1206 $data = json_decode($curlResult->getBody(), true);
1211 if (count($data) == 1) {
1212 $serverdata['directory-type'] = self::DT_MASTODON;
1219 * Detects Peertube via their known endpoint
1221 * @param string $url URL of the given server
1222 * @param array $serverdata array with server data
1224 * @return array server data
1226 private static function detectPeertube(string $url, array $serverdata)
1228 $curlResult = DI::httpClient()->get($url . '/api/v1/config');
1230 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1234 $data = json_decode($curlResult->getBody(), true);
1239 if (!empty($data['instance']) && !empty($data['serverVersion'])) {
1240 $serverdata['platform'] = 'peertube';
1241 $serverdata['version'] = $data['serverVersion'];
1242 $serverdata['network'] = Protocol::ACTIVITYPUB;
1244 if (!empty($data['instance']['name'])) {
1245 $serverdata['site_name'] = $data['instance']['name'];
1248 if (!empty($data['instance']['shortDescription'])) {
1249 $serverdata['info'] = $data['instance']['shortDescription'];
1252 if (!empty($data['signup'])) {
1253 if (!empty($data['signup']['allowed'])) {
1254 $serverdata['register_policy'] = Register::OPEN;
1258 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1259 $serverdata['detection-method'] = self::DETECT_V1_CONFIG;
1267 * Detects the version number of a given server when it was a NextCloud installation
1269 * @param string $url URL of the given server
1270 * @param array $serverdata array with server data
1272 * @return array server data
1274 private static function detectNextcloud(string $url, array $serverdata)
1276 $curlResult = DI::httpClient()->get($url . '/status.php');
1278 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1282 $data = json_decode($curlResult->getBody(), true);
1287 if (!empty($data['version'])) {
1288 $serverdata['platform'] = 'nextcloud';
1289 $serverdata['version'] = $data['version'];
1290 $serverdata['network'] = Protocol::ACTIVITYPUB;
1292 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1293 $serverdata['detection-method'] = self::DETECT_STATUS_PHP;
1300 private static function fetchWeeklyUsage(string $url, array $serverdata) {
1301 $curlResult = DI::httpClient()->get($url . '/api/v1/instance/activity');
1303 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1307 $data = json_decode($curlResult->getBody(), true);
1313 foreach ($data as $week) {
1314 // Use only data from a full week
1315 if (empty($week['week']) || (time() - $week['week']) < 7 * 24 * 60 * 60) {
1319 // Most likely the data is sorted correctly. But we better are safe than sorry
1320 if (empty($current_week['week']) || ($current_week['week'] < $week['week'])) {
1321 $current_week = $week;
1325 if (!empty($current_week['logins'])) {
1326 $serverdata['active-week-users'] = max($current_week['logins'], 0);
1333 * Detects data from a given server url if it was a mastodon alike system
1335 * @param string $url URL of the given server
1336 * @param array $serverdata array with server data
1338 * @return array server data
1340 private static function detectMastodonAlikes(string $url, array $serverdata)
1342 $curlResult = DI::httpClient()->get($url . '/api/v1/instance');
1344 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1348 $data = json_decode($curlResult->getBody(), true);
1353 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1354 $serverdata['detection-method'] = self::DETECT_MASTODON_API;
1357 if (!empty($data['version'])) {
1358 $serverdata['platform'] = 'mastodon';
1359 $serverdata['version'] = $data['version'] ?? '';
1360 $serverdata['network'] = Protocol::ACTIVITYPUB;
1363 if (!empty($data['title'])) {
1364 $serverdata['site_name'] = $data['title'];
1367 if (!empty($data['title']) && empty($serverdata['platform']) && empty($serverdata['network'])) {
1368 $serverdata['platform'] = 'mastodon';
1369 $serverdata['network'] = Protocol::ACTIVITYPUB;
1372 if (!empty($data['description'])) {
1373 $serverdata['info'] = trim($data['description']);
1376 if (!empty($data['stats']['user_count'])) {
1377 $serverdata['registered-users'] = max($data['stats']['user_count'], 1);
1380 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
1381 $serverdata['platform'] = strtolower($matches[1]);
1382 $serverdata['version'] = $matches[2];
1385 if (!empty($serverdata['version']) && strstr(strtolower($serverdata['version']), 'pleroma')) {
1386 $serverdata['platform'] = 'pleroma';
1387 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1390 if (!empty($serverdata['platform']) && strstr($serverdata['platform'], 'pleroma')) {
1391 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['platform']));
1392 $serverdata['platform'] = 'pleroma';
1399 * Detects data from typical Hubzilla endpoints
1401 * @param string $url URL of the given server
1402 * @param array $serverdata array with server data
1404 * @return array server data
1406 private static function detectHubzilla(string $url, array $serverdata)
1408 $curlResult = DI::httpClient()->get($url . '/api/statusnet/config.json');
1409 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1413 $data = json_decode($curlResult->getBody(), true);
1414 if (empty($data) || empty($data['site'])) {
1418 if (!empty($data['site']['name'])) {
1419 $serverdata['site_name'] = $data['site']['name'];
1422 if (!empty($data['site']['platform'])) {
1423 $serverdata['platform'] = strtolower($data['site']['platform']['PLATFORM_NAME']);
1424 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
1425 $serverdata['network'] = Protocol::ZOT;
1428 if (!empty($data['site']['hubzilla'])) {
1429 $serverdata['platform'] = strtolower($data['site']['hubzilla']['PLATFORM_NAME']);
1430 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
1431 $serverdata['network'] = Protocol::ZOT;
1434 if (!empty($data['site']['redmatrix'])) {
1435 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
1436 $serverdata['platform'] = strtolower($data['site']['redmatrix']['PLATFORM_NAME']);
1437 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
1438 $serverdata['platform'] = strtolower($data['site']['redmatrix']['RED_PLATFORM']);
1441 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
1442 $serverdata['network'] = Protocol::ZOT;
1446 $inviteonly = false;
1449 if (!empty($data['site']['closed'])) {
1450 $closed = self::toBoolean($data['site']['closed']);
1453 if (!empty($data['site']['private'])) {
1454 $private = self::toBoolean($data['site']['private']);
1457 if (!empty($data['site']['inviteonly'])) {
1458 $inviteonly = self::toBoolean($data['site']['inviteonly']);
1461 if (!$closed && !$private and $inviteonly) {
1462 $serverdata['register_policy'] = Register::APPROVE;
1463 } elseif (!$closed && !$private) {
1464 $serverdata['register_policy'] = Register::OPEN;
1466 $serverdata['register_policy'] = Register::CLOSED;
1469 if (!empty($serverdata['network']) && in_array($serverdata['detection-method'],
1470 [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1471 $serverdata['detection-method'] = self::DETECT_CONFIG_JSON;
1478 * Converts input value to a boolean value
1480 * @param string|integer $val
1484 private static function toBoolean($val)
1486 if (($val == 'true') || ($val == 1)) {
1488 } elseif (($val == 'false') || ($val == 0)) {
1496 * Detect if the URL belongs to a pump.io server
1498 * @param string $url URL of the given server
1499 * @param array $serverdata array with server data
1501 * @return array server data
1503 private static function detectPumpIO(string $url, array $serverdata)
1505 $curlResult = DI::httpClient()->get($url . '/.well-known/host-meta.json');
1506 if (!$curlResult->isSuccess()) {
1510 $data = json_decode($curlResult->getBody(), true);
1511 if (empty($data['links'])) {
1516 // We are looking for some endpoints that are typical for pump.io
1518 foreach ($data['links'] as $link) {
1519 if (empty($link['rel'])) {
1522 if (in_array($link['rel'], ['registration_endpoint', 'dialback', 'http://apinamespace.org/activitypub/whoami'])) {
1528 $serverdata['detection-method'] = self::DETECT_PUMPIO;
1530 $serverdata['platform'] = 'pumpio';
1531 $serverdata['version'] = '';
1532 $serverdata['network'] = Protocol::PUMPIO;
1534 $servers = $curlResult->getHeader('Server');
1535 foreach ($servers as $server) {
1536 if (preg_match("#pump.io/(.*)\s#U", $server, $matches)) {
1537 $serverdata['version'] = $matches[1];
1546 * Detect if the URL belongs to a GNU Social server
1548 * @param string $url URL of the given server
1549 * @param array $serverdata array with server data
1551 * @return array server data
1553 private static function detectGNUSocial(string $url, array $serverdata)
1555 // Test for GNU Social
1556 $curlResult = DI::httpClient()->get($url . '/api/gnusocial/version.json');
1557 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1558 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1559 $serverdata['platform'] = 'gnusocial';
1560 // Remove junk that some GNU Social servers return
1561 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
1562 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1563 $serverdata['version'] = trim($serverdata['version'], '"');
1564 $serverdata['network'] = Protocol::OSTATUS;
1566 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1567 $serverdata['detection-method'] = self::DETECT_GNUSOCIAL;
1573 // Test for Statusnet
1574 $curlResult = DI::httpClient()->get($url . '/api/statusnet/version.json');
1575 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1576 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1578 // Remove junk that some GNU Social servers return
1579 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
1580 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1581 $serverdata['version'] = trim($serverdata['version'], '"');
1583 if (!empty($serverdata['version']) && strtolower(substr($serverdata['version'], 0, 7)) == 'pleroma') {
1584 $serverdata['platform'] = 'pleroma';
1585 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1586 $serverdata['network'] = Protocol::ACTIVITYPUB;
1588 $serverdata['platform'] = 'statusnet';
1589 $serverdata['network'] = Protocol::OSTATUS;
1592 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1593 $serverdata['detection-method'] = self::DETECT_STATUSNET;
1601 * Detect if the URL belongs to a Friendica server
1603 * @param string $url URL of the given server
1604 * @param array $serverdata array with server data
1606 * @return array server data
1608 private static function detectFriendica(string $url, array $serverdata)
1610 $curlResult = DI::httpClient()->get($url . '/friendica/json');
1611 if (!$curlResult->isSuccess()) {
1612 $curlResult = DI::httpClient()->get($url . '/friendika/json');
1614 $platform = 'Friendika';
1617 $platform = 'Friendica';
1620 if (!$curlResult->isSuccess()) {
1624 $data = json_decode($curlResult->getBody(), true);
1625 if (empty($data) || empty($data['version'])) {
1629 if (in_array($serverdata['detection-method'], [self::DETECT_HEADER, self::DETECT_BODY, self::DETECT_MANUAL])) {
1630 $serverdata['detection-method'] = $friendika ? self::DETECT_FRIENDIKA : self::DETECT_FRIENDICA;
1633 $serverdata['network'] = Protocol::DFRN;
1634 $serverdata['version'] = $data['version'];
1636 if (!empty($data['no_scrape_url'])) {
1637 $serverdata['noscrape'] = $data['no_scrape_url'];
1640 if (!empty($data['site_name'])) {
1641 $serverdata['site_name'] = $data['site_name'];
1644 if (!empty($data['info'])) {
1645 $serverdata['info'] = trim($data['info']);
1648 $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
1649 switch ($register_policy) {
1650 case 'REGISTER_OPEN':
1651 $serverdata['register_policy'] = Register::OPEN;
1654 case 'REGISTER_APPROVE':
1655 $serverdata['register_policy'] = Register::APPROVE;
1658 case 'REGISTER_CLOSED':
1659 case 'REGISTER_INVITATION':
1660 $serverdata['register_policy'] = Register::CLOSED;
1663 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
1664 $serverdata['register_policy'] = Register::CLOSED;
1668 $serverdata['platform'] = strtolower($data['platform'] ?? $platform);
1674 * Analyses the landing page of a given server for hints about type and system of that server
1676 * @param object $curlResult result of curl execution
1677 * @param array $serverdata array with server data
1678 * @param string $url Server URL
1680 * @return array server data
1682 private static function analyseRootBody($curlResult, array $serverdata, string $url)
1684 if (empty($curlResult->getBody())) {
1688 // Using only body information we cannot safely detect a lot of systems.
1689 // So we define a list of platforms that we can detect safely.
1690 $valid_platforms = ['friendica', 'friendika', 'diaspora', 'mastodon', 'hubzilla', 'misskey', 'peertube', 'wordpress', 'write.as'];
1692 $doc = new DOMDocument();
1693 @$doc->loadHTML($curlResult->getBody());
1694 $xpath = new DOMXPath($doc);
1696 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1697 if (!empty($title)) {
1698 $serverdata['site_name'] = $title;
1701 $list = $xpath->query('//meta[@name]');
1703 foreach ($list as $node) {
1705 if ($node->attributes->length) {
1706 foreach ($node->attributes as $attribute) {
1707 $value = trim($attribute->value);
1708 if (empty($value)) {
1712 $attr[$attribute->name] = $value;
1715 if (empty($attr['name']) || empty($attr['content'])) {
1720 if ($attr['name'] == 'description') {
1721 $serverdata['info'] = $attr['content'];
1724 if (in_array($attr['name'], ['application-name', 'al:android:app_name', 'al:ios:app_name',
1725 'twitter:app:name:googleplay', 'twitter:app:name:iphone', 'twitter:app:name:ipad'])) {
1726 $serverdata['platform'] = strtolower($attr['content']);
1727 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1728 $serverdata['network'] = Protocol::ACTIVITYPUB;
1731 if (($attr['name'] == 'generator') && (empty($serverdata['platform']) || (substr(strtolower($attr['content']), 0, 9) == 'wordpress'))) {
1732 $serverdata['platform'] = strtolower($attr['content']);
1733 $version_part = explode(' ', $attr['content']);
1735 if (count($version_part) == 2) {
1736 if (in_array($version_part[0], ['WordPress'])) {
1737 $serverdata['platform'] = 'wordpress';
1738 $serverdata['version'] = $version_part[1];
1740 // We still do need a reliable test if some AP plugin is activated
1741 // By now we just check in a later process for some known contacts
1742 $serverdata['network'] = Protocol::FEED;
1744 if ($serverdata['detection-method'] == self::DETECT_MANUAL) {
1745 $serverdata['detection-method'] = self::DETECT_BODY;
1748 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1749 $serverdata['platform'] = strtolower($version_part[0]);
1750 $serverdata['version'] = $version_part[1];
1751 $serverdata['network'] = Protocol::DFRN;
1757 $list = $xpath->query('//meta[@property]');
1759 foreach ($list as $node) {
1761 if ($node->attributes->length) {
1762 foreach ($node->attributes as $attribute) {
1763 $value = trim($attribute->value);
1764 if (empty($value)) {
1768 $attr[$attribute->name] = $value;
1771 if (empty($attr['property']) || empty($attr['content'])) {
1776 if ($attr['property'] == 'og:site_name') {
1777 $serverdata['site_name'] = $attr['content'];
1780 if ($attr['property'] == 'og:description') {
1781 $serverdata['info'] = $attr['content'];
1784 if ($attr['property'] == 'og:platform') {
1785 $serverdata['platform'] = strtolower($attr['content']);
1787 if (in_array($attr['content'], ['PeerTube'])) {
1788 $serverdata['network'] = Protocol::ACTIVITYPUB;
1792 if ($attr['property'] == 'generator') {
1793 $serverdata['platform'] = strtolower($attr['content']);
1795 if (in_array($attr['content'], ['hubzilla'])) {
1796 // We later check which compatible protocol modules are loaded.
1797 $serverdata['network'] = Protocol::ZOT;
1802 if (!empty($serverdata['platform']) && in_array($serverdata['detection-method'], [self::DETECT_MANUAL, self::DETECT_BODY]) && !in_array($serverdata['platform'], $valid_platforms)) {
1803 $serverdata['network'] = Protocol::PHANTOM;
1804 $serverdata['version'] = '';
1805 $serverdata['detection-method'] = self::DETECT_MANUAL;
1806 } elseif (!empty($serverdata['network']) && ($serverdata['detection-method'] == self::DETECT_MANUAL)) {
1807 $serverdata['detection-method'] = self::DETECT_BODY;
1814 * Analyses the header data of a given server for hints about type and system of that server
1816 * @param object $curlResult result of curl execution
1817 * @param array $serverdata array with server data
1819 * @return array server data
1821 private static function analyseRootHeader($curlResult, array $serverdata)
1823 if ($curlResult->getHeader('server') == 'Mastodon') {
1824 $serverdata['platform'] = 'mastodon';
1825 $serverdata['network'] = Protocol::ACTIVITYPUB;
1826 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1827 $serverdata['platform'] = 'diaspora';
1828 $serverdata['network'] = Protocol::DIASPORA;
1829 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version')[0] ?? '';
1830 } elseif ($curlResult->inHeader('x-friendica-version')) {
1831 $serverdata['platform'] = 'friendica';
1832 $serverdata['network'] = Protocol::DFRN;
1833 $serverdata['version'] = $curlResult->getHeader('x-friendica-version')[0] ?? '';
1838 if ($serverdata['detection-method'] == self::DETECT_MANUAL) {
1839 $serverdata['detection-method'] = self::DETECT_HEADER;
1846 * Test if the body contains valid content
1848 * @param string $body
1851 private static function invalidBody(string $body)
1853 // Currently we only test for a HTML element.
1854 // Possibly we enhance this in the future.
1855 return !strpos($body, '>');
1859 * Update GServer entries
1861 public static function discover()
1863 // Update the server list
1864 self::discoverFederation();
1868 $requery_days = intval(DI::config()->get('system', 'poco_requery_days'));
1870 if ($requery_days == 0) {
1874 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
1876 $gservers = DBA::select('gserver', ['id', 'url', 'nurl', 'network', 'poco', 'directory-type'],
1877 ["NOT `failed` AND `directory-type` != ? AND `last_poco_query` < ?", GServer::DT_NONE, $last_update],
1878 ['order' => ['RAND()']]);
1880 while ($gserver = DBA::fetch($gservers)) {
1881 Logger::info('Update peer list', ['server' => $gserver['url'], 'id' => $gserver['id']]);
1882 Worker::add(PRIORITY_LOW, 'UpdateServerPeers', $gserver['url']);
1884 Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
1885 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
1887 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
1888 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
1890 if (--$no_of_queries == 0) {
1895 DBA::close($gservers);
1899 * Discover federated servers
1901 private static function discoverFederation()
1903 $last = DI::config()->get('poco', 'last_federation_discovery');
1906 $next = $last + (24 * 60 * 60);
1908 if ($next > time()) {
1913 // Discover federated servers
1914 $protocols = ['activitypub', 'diaspora', 'dfrn', 'ostatus'];
1915 foreach ($protocols as $protocol) {
1916 $query = '{nodes(protocol:"' . $protocol . '"){host}}';
1917 $curlResult = DI::httpClient()->fetch('https://the-federation.info/graphql?query=' . urlencode($query));
1918 if (!empty($curlResult)) {
1919 $data = json_decode($curlResult, true);
1920 if (!empty($data['data']['nodes'])) {
1921 foreach ($data['data']['nodes'] as $server) {
1922 // Using "only_nodeinfo" since servers that are listed on that page should always have it.
1923 self::add('https://' . $server['host'], true);
1929 // Disvover Mastodon servers
1930 $accesstoken = DI::config()->get('system', 'instances_social_key');
1932 if (!empty($accesstoken)) {
1933 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1934 $curlResult = DI::httpClient()->get($api, [HttpClientOptions::HEADERS => ['Authorization' => ['Bearer ' . $accesstoken]]]);
1936 if ($curlResult->isSuccess()) {
1937 $servers = json_decode($curlResult->getBody(), true);
1939 foreach ($servers['instances'] as $server) {
1940 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
1946 DI::config()->set('poco', 'last_federation_discovery', time());
1950 * Set the protocol for the given server
1952 * @param int $gsid Server id
1953 * @param int $protocol Protocol id
1957 public static function setProtocol(int $gsid, int $protocol)
1963 $gserver = DBA::selectFirst('gserver', ['protocol', 'url'], ['id' => $gsid]);
1964 if (!DBA::isResult($gserver)) {
1968 $old = $gserver['protocol'];
1970 if (!is_null($old)) {
1972 The priority for the protocols is:
1974 2. DFRN via Diaspora
1980 // We don't need to change it when nothing is to be changed
1981 if ($old == $protocol) {
1985 // We don't want to mark a server as OStatus when it had been marked with any other protocol before
1986 if ($protocol == Post\DeliveryData::OSTATUS) {
1990 // If the server is marked as ActivityPub then we won't change it to anything different
1991 if ($old == Post\DeliveryData::ACTIVITYPUB) {
1995 // Don't change it to anything lower than DFRN if the new one wasn't ActivityPub
1996 if (($old == Post\DeliveryData::DFRN) && ($protocol != Post\DeliveryData::ACTIVITYPUB)) {
2000 // Don't change it to Diaspora when it is a legacy DFRN server
2001 if (($old == Post\DeliveryData::LEGACY_DFRN) && ($protocol == Post\DeliveryData::DIASPORA)) {
2006 Logger::info('Protocol for server', ['protocol' => $protocol, 'old' => $old, 'id' => $gsid, 'url' => $gserver['url'], 'callstack' => System::callstack(20)]);
2007 DBA::update('gserver', ['protocol' => $protocol], ['id' => $gsid]);
2011 * Fetch the protocol of the given server
2013 * @param int $gsid Server id
2017 public static function getProtocol(int $gsid)
2023 $gserver = DBA::selectFirst('gserver', ['protocol'], ['id' => $gsid]);
2024 if (DBA::isResult($gserver)) {
2025 return $gserver['protocol'];