3 * @copyright Copyright (C) 2020, Friendica
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;
26 use Friendica\Core\Protocol;
27 use Friendica\Core\Worker;
28 use Friendica\Database\DBA;
30 use Friendica\Module\Register;
31 use Friendica\Network\CurlResult;
32 use Friendica\Util\Network;
33 use Friendica\Util\DateTimeFormat;
34 use Friendica\Util\Strings;
35 use Friendica\Util\XML;
36 use Friendica\Core\Logger;
37 use Friendica\Protocol\PortableContact;
38 use Friendica\Protocol\Diaspora;
39 use Friendica\Network\Probe;
42 * This class handles GServer related functions
49 const DT_MASTODON = 2;
51 * Checks if the given server is reachable
53 * @param string $profile URL of the given profile
54 * @param string $server URL of the given server (If empty, taken from profile)
55 * @param string $network Network value that is used, when detection failed
56 * @param boolean $force Force an update.
58 * @return boolean 'true' if server seems vital
60 public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false)
63 $server = GContact::getBasepath($profile);
70 return self::check($server, $network, $force);
74 * Decides if a server needs to be updated, based upon several date fields
76 * @param date $created Creation date of that server entry
77 * @param date $updated When had the server entry be updated
78 * @param date $last_failure Last failure when contacting that server
79 * @param date $last_contact Last time the server had been contacted
81 * @return boolean Does the server record needs an update?
83 public static function updateNeeded($created, $updated, $last_failure, $last_contact)
85 $now = strtotime(DateTimeFormat::utcNow());
87 if ($updated > $last_contact) {
88 $contact_time = strtotime($updated);
90 $contact_time = strtotime($last_contact);
93 $failure_time = strtotime($last_failure);
94 $created_time = strtotime($created);
96 // If there is no "created" time then use the current time
97 if ($created_time <= 0) {
101 // If the last contact was less than 24 hours then don't update
102 if (($now - $contact_time) < (60 * 60 * 24)) {
106 // If the last failure was less than 24 hours then don't update
107 if (($now - $failure_time) < (60 * 60 * 24)) {
111 // If the last contact was less than a week ago and the last failure is older than a week then don't update
112 //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
115 // 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
116 if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
120 // 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
121 if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
129 * Checks the state of the given server.
131 * @param string $server_url URL of the given server
132 * @param string $network Network value that is used, when detection failed
133 * @param boolean $force Force an update.
135 * @return boolean 'true' if server seems vital
137 public static function check(string $server_url, string $network = '', bool $force = false)
139 // Unify the server address
140 $server_url = trim($server_url, '/');
141 $server_url = str_replace('/index.php', '', $server_url);
143 if ($server_url == '') {
147 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
148 if (DBA::isResult($gserver)) {
149 if ($gserver['created'] <= DBA::NULL_DATETIME) {
150 $fields = ['created' => DateTimeFormat::utcNow()];
151 $condition = ['nurl' => Strings::normaliseLink($server_url)];
152 DBA::update('gserver', $fields, $condition);
155 $last_contact = $gserver['last_contact'];
156 $last_failure = $gserver['last_failure'];
158 // See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
159 // It can happen that a zero date is in the database, but storing it again is forbidden.
160 if ($last_contact < DBA::NULL_DATETIME) {
161 $last_contact = DBA::NULL_DATETIME;
164 if ($last_failure < DBA::NULL_DATETIME) {
165 $last_failure = DBA::NULL_DATETIME;
168 if (!$force && !self::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
169 Logger::info('No update needed', ['server' => $server_url]);
170 return ($last_contact >= $last_failure);
172 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
174 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
177 return self::detect($server_url, $network);
181 * Detect server data (type, protocol, version number, ...)
182 * The detected data is then updated or inserted in the gserver table.
184 * @param string $url URL of the given server
185 * @param string $network Network value that is used, when detection failed
187 * @return boolean 'true' if server could be detected
189 public static function detect(string $url, string $network = '')
191 Logger::info('Detect server type', ['server' => $url]);
194 $original_url = $url;
196 // Remove URL content that is not supposed to exist for a server url
197 $urlparts = parse_url($url);
198 unset($urlparts['user']);
199 unset($urlparts['pass']);
200 unset($urlparts['query']);
201 unset($urlparts['fragment']);
202 $url = Network::unparseURL($urlparts);
204 // If the URL missmatches, then we mark the old entry as failure
205 if ($url != $original_url) {
206 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($original_url)]);
209 // When a nodeinfo is present, we don't need to dig further
210 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
211 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
212 if ($curlResult->isTimeout()) {
213 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
217 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
219 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
220 if (empty($nodeinfo)) {
221 $nodeinfo = self::fetchStatistics($url);
224 // If that didn't work out well, we use some protocol specific endpoints
225 // For Friendica and Zot based networks we have to dive deeper to reveal more details
226 if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
227 // Fetch the landing page, possibly it reveals some data
228 if (empty($nodeinfo['network'])) {
229 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
230 if ($curlResult->isSuccess()) {
231 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
232 $serverdata = self::analyseRootBody($curlResult, $serverdata, $url);
235 if (!$curlResult->isSuccess() || empty($curlResult->getBody()) || self::invalidBody($curlResult->getBody())) {
236 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
241 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
242 $serverdata = self::detectMastodonAlikes($url, $serverdata);
245 // All following checks are done for systems that always have got a "host-meta" endpoint.
246 // With this check we don't have to waste time and ressources for dead systems.
247 // Also this hopefully prevents us from receiving abuse messages.
248 if (empty($serverdata['network']) && !self::validHostMeta($url)) {
249 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
253 if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
254 $serverdata = self::detectFriendica($url, $serverdata);
257 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
258 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
259 $serverdata = self::fetchSiteinfo($url, $serverdata);
262 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
263 if (empty($serverdata['network'])) {
264 $serverdata = self::detectHubzilla($url, $serverdata);
267 if (empty($serverdata['network'])) {
268 $serverdata = self::detectNextcloud($url, $serverdata);
271 if (empty($serverdata['network'])) {
272 $serverdata = self::detectGNUSocial($url, $serverdata);
275 $serverdata = $nodeinfo;
278 // Detect the directory type
279 $serverdata['directory-type'] = self::DT_NONE;
280 $serverdata = self::checkPoCo($url, $serverdata);
281 $serverdata = self::checkMastodonDirectory($url, $serverdata);
283 // We can't detect the network type. Possibly it is some system that we don't know yet
284 if (empty($serverdata['network'])) {
285 $serverdata['network'] = Protocol::PHANTOM;
288 // When we hadn't been able to detect the network type, we use the hint from the parameter
289 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
290 $serverdata['network'] = $network;
293 $serverdata['url'] = $url;
294 $serverdata['nurl'] = Strings::normaliseLink($url);
296 // We take the highest number that we do find
297 $registeredUsers = $serverdata['registered-users'] ?? 0;
299 // On an active server there has to be at least a single user
300 if (($serverdata['network'] != Protocol::PHANTOM) && ($registeredUsers == 0)) {
301 $registeredUsers = 1;
304 if ($serverdata['network'] != Protocol::PHANTOM) {
305 $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
306 $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
307 $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
308 $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
310 $serverdata['registered-users'] = $registeredUsers;
311 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
314 $serverdata['last_contact'] = DateTimeFormat::utcNow();
316 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
317 if (!DBA::isResult($gserver)) {
318 $serverdata['created'] = DateTimeFormat::utcNow();
319 $ret = DBA::insert('gserver', $serverdata);
321 // Don't override the network with 'unknown' when there had been a valid entry before
322 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
323 unset($serverdata['network']);
326 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
329 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
330 self::discoverRelay($url);
337 * Fetch relay data from a given server url
339 * @param string $server_url address of the server
340 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
342 public static function discoverRelay(string $server_url)
344 Logger::info('Discover relay data', ['server' => $server_url]);
346 $curlResult = Network::curl($server_url . '/.well-known/x-social-relay');
347 if (!$curlResult->isSuccess()) {
351 $data = json_decode($curlResult->getBody(), true);
352 if (!is_array($data)) {
356 // Sanitize incoming data, see https://github.com/friendica/friendica/issues/8565
357 $data['subscribe'] = (bool)$data['subscribe'] ?? false;
359 if (!$data['subscribe'] || empty($data['scope']) || !in_array(strtolower($data['scope']), ['all', 'tags'])) {
361 $data['subscribe'] = false;
365 $gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
366 if (!DBA::isResult($gserver)) {
370 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
371 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
372 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
375 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
377 if ($data['scope'] == 'tags') {
380 foreach ($data['tags'] as $tag) {
381 $tag = mb_strtolower($tag);
382 if (strlen($tag) < 100) {
387 foreach ($tags as $tag) {
388 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], true);
392 // Create or update the relay contact
394 if (isset($data['protocols'])) {
395 if (isset($data['protocols']['diaspora'])) {
396 $fields['network'] = Protocol::DIASPORA;
398 if (isset($data['protocols']['diaspora']['receive'])) {
399 $fields['batch'] = $data['protocols']['diaspora']['receive'];
400 } elseif (is_string($data['protocols']['diaspora'])) {
401 $fields['batch'] = $data['protocols']['diaspora'];
405 if (isset($data['protocols']['dfrn'])) {
406 $fields['network'] = Protocol::DFRN;
408 if (isset($data['protocols']['dfrn']['receive'])) {
409 $fields['batch'] = $data['protocols']['dfrn']['receive'];
410 } elseif (is_string($data['protocols']['dfrn'])) {
411 $fields['batch'] = $data['protocols']['dfrn'];
415 Diaspora::setRelayContact($server_url, $fields);
419 * Fetch server data from '/statistics.json' on the given server
421 * @param string $url URL of the given server
423 * @return array server data
425 private static function fetchStatistics(string $url)
427 $curlResult = Network::curl($url . '/statistics.json');
428 if (!$curlResult->isSuccess()) {
432 $data = json_decode($curlResult->getBody(), true);
439 if (!empty($data['version'])) {
440 $serverdata['version'] = $data['version'];
441 // Version numbers on statistics.json are presented with additional info, e.g.:
442 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
443 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
446 if (!empty($data['name'])) {
447 $serverdata['site_name'] = $data['name'];
450 if (!empty($data['network'])) {
451 $serverdata['platform'] = strtolower($data['network']);
453 if ($serverdata['platform'] == 'diaspora') {
454 $serverdata['network'] = Protocol::DIASPORA;
455 } elseif ($serverdata['platform'] == 'friendica') {
456 $serverdata['network'] = Protocol::DFRN;
457 } elseif ($serverdata['platform'] == 'hubzilla') {
458 $serverdata['network'] = Protocol::ZOT;
459 } elseif ($serverdata['platform'] == 'redmatrix') {
460 $serverdata['network'] = Protocol::ZOT;
465 if (!empty($data['registrations_open'])) {
466 $serverdata['register_policy'] = Register::OPEN;
468 $serverdata['register_policy'] = Register::CLOSED;
475 * Detect server type by using the nodeinfo data
477 * @param string $url address of the server
478 * @param CurlResult $curlResult
479 * @return array Server data
480 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
482 private static function fetchNodeinfo(string $url, CurlResult $curlResult)
484 $nodeinfo = json_decode($curlResult->getBody(), true);
486 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
493 foreach ($nodeinfo['links'] as $link) {
494 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
495 Logger::info('Invalid nodeinfo format', ['url' => $url]);
498 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
499 $nodeinfo1_url = $link['href'];
500 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
501 $nodeinfo2_url = $link['href'];
505 if ($nodeinfo1_url . $nodeinfo2_url == '') {
511 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
512 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
513 $server = self::parseNodeinfo2($nodeinfo2_url);
516 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
517 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
518 $server = self::parseNodeinfo1($nodeinfo1_url);
527 * @param string $nodeinfo_url address of the nodeinfo path
528 * @return array Server data
529 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
531 private static function parseNodeinfo1(string $nodeinfo_url)
533 $curlResult = Network::curl($nodeinfo_url);
535 if (!$curlResult->isSuccess()) {
539 $nodeinfo = json_decode($curlResult->getBody(), true);
541 if (!is_array($nodeinfo)) {
547 $server['register_policy'] = Register::CLOSED;
549 if (!empty($nodeinfo['openRegistrations'])) {
550 $server['register_policy'] = Register::OPEN;
553 if (is_array($nodeinfo['software'])) {
554 if (!empty($nodeinfo['software']['name'])) {
555 $server['platform'] = strtolower($nodeinfo['software']['name']);
558 if (!empty($nodeinfo['software']['version'])) {
559 $server['version'] = $nodeinfo['software']['version'];
560 // Version numbers on Nodeinfo are presented with additional info, e.g.:
561 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
562 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
566 if (!empty($nodeinfo['metadata']['nodeName'])) {
567 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
570 if (!empty($nodeinfo['usage']['users']['total'])) {
571 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
574 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
576 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
577 $protocols[$protocol] = true;
580 if (!empty($protocols['friendica'])) {
581 $server['network'] = Protocol::DFRN;
582 } elseif (!empty($protocols['activitypub'])) {
583 $server['network'] = Protocol::ACTIVITYPUB;
584 } elseif (!empty($protocols['diaspora'])) {
585 $server['network'] = Protocol::DIASPORA;
586 } elseif (!empty($protocols['ostatus'])) {
587 $server['network'] = Protocol::OSTATUS;
588 } elseif (!empty($protocols['gnusocial'])) {
589 $server['network'] = Protocol::OSTATUS;
590 } elseif (!empty($protocols['zot'])) {
591 $server['network'] = Protocol::ZOT;
595 if (empty($server)) {
605 * @param string $nodeinfo_url address of the nodeinfo path
606 * @return array Server data
607 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
609 private static function parseNodeinfo2(string $nodeinfo_url)
611 $curlResult = Network::curl($nodeinfo_url);
612 if (!$curlResult->isSuccess()) {
616 $nodeinfo = json_decode($curlResult->getBody(), true);
618 if (!is_array($nodeinfo)) {
624 $server['register_policy'] = Register::CLOSED;
626 if (!empty($nodeinfo['openRegistrations'])) {
627 $server['register_policy'] = Register::OPEN;
630 if (is_array($nodeinfo['software'])) {
631 if (!empty($nodeinfo['software']['name'])) {
632 $server['platform'] = strtolower($nodeinfo['software']['name']);
635 if (!empty($nodeinfo['software']['version'])) {
636 $server['version'] = $nodeinfo['software']['version'];
637 // Version numbers on Nodeinfo are presented with additional info, e.g.:
638 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
639 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
643 if (!empty($nodeinfo['metadata']['nodeName'])) {
644 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
647 if (!empty($nodeinfo['usage']['users']['total'])) {
648 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
651 if (!empty($nodeinfo['protocols'])) {
653 foreach ($nodeinfo['protocols'] as $protocol) {
654 $protocols[$protocol] = true;
657 if (!empty($protocols['dfrn'])) {
658 $server['network'] = Protocol::DFRN;
659 } elseif (!empty($protocols['activitypub'])) {
660 $server['network'] = Protocol::ACTIVITYPUB;
661 } elseif (!empty($protocols['diaspora'])) {
662 $server['network'] = Protocol::DIASPORA;
663 } elseif (!empty($protocols['ostatus'])) {
664 $server['network'] = Protocol::OSTATUS;
665 } elseif (!empty($protocols['gnusocial'])) {
666 $server['network'] = Protocol::OSTATUS;
667 } elseif (!empty($protocols['zot'])) {
668 $server['network'] = Protocol::ZOT;
672 if (empty($server)) {
680 * Fetch server information from a 'siteinfo.json' file on the given server
682 * @param string $url URL of the given server
683 * @param array $serverdata array with server data
685 * @return array server data
687 private static function fetchSiteinfo(string $url, array $serverdata)
689 $curlResult = Network::curl($url . '/siteinfo.json');
690 if (!$curlResult->isSuccess()) {
694 $data = json_decode($curlResult->getBody(), true);
699 if (!empty($data['url'])) {
700 $serverdata['platform'] = strtolower($data['platform']);
701 $serverdata['version'] = $data['version'];
704 if (!empty($data['plugins'])) {
705 if (in_array('pubcrawl', $data['plugins'])) {
706 $serverdata['network'] = Protocol::ACTIVITYPUB;
707 } elseif (in_array('diaspora', $data['plugins'])) {
708 $serverdata['network'] = Protocol::DIASPORA;
709 } elseif (in_array('gnusoc', $data['plugins'])) {
710 $serverdata['network'] = Protocol::OSTATUS;
712 $serverdata['network'] = Protocol::ZOT;
716 if (!empty($data['site_name'])) {
717 $serverdata['site_name'] = $data['site_name'];
720 if (!empty($data['channels_total'])) {
721 $serverdata['registered-users'] = $data['channels_total'];
724 if (!empty($data['register_policy'])) {
725 switch ($data['register_policy']) {
726 case 'REGISTER_OPEN':
727 $serverdata['register_policy'] = Register::OPEN;
730 case 'REGISTER_APPROVE':
731 $serverdata['register_policy'] = Register::APPROVE;
734 case 'REGISTER_CLOSED':
736 $serverdata['register_policy'] = Register::CLOSED;
745 * Checks if the server contains a valid host meta file
747 * @param string $url URL of the given server
749 * @return boolean 'true' if the server seems to be vital
751 private static function validHostMeta(string $url)
753 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
754 $curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
755 if (!$curlResult->isSuccess()) {
759 $xrd = XML::parseString($curlResult->getBody());
760 if (!is_object($xrd)) {
764 $elements = XML::elementToArray($xrd);
765 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
770 foreach ($elements['xrd']['link'] as $link) {
771 // When there is more than a single "link" element, the array looks slightly different
772 if (!empty($link['@attributes'])) {
773 $link = $link['@attributes'];
776 if (empty($link['rel']) || empty($link['template'])) {
780 if ($link['rel'] == 'lrdd') {
781 // When the webfinger host is the same like the system host, it should be ok.
782 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
790 * Detect the network of the given server via their known contacts
792 * @param string $url URL of the given server
793 * @param array $serverdata array with server data
795 * @return array server data
797 private static function detectNetworkViaContacts(string $url, array $serverdata)
801 $gcontacts = DBA::select('gcontact', ['url', 'nurl'], ['server_url' => [$url, $serverdata['nurl']]]);
802 while ($gcontact = DBA::fetch($gcontacts)) {
803 $contacts[$gcontact['nurl']] = $gcontact['url'];
805 DBA::close($gcontacts);
807 $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
808 while ($apcontact = DBA::fetch($apcontacts)) {
809 $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
811 DBA::close($apcontacts);
813 $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
814 while ($pcontact = DBA::fetch($pcontacts)) {
815 $contacts[$pcontact['nurl']] = $pcontact['url'];
817 DBA::close($pcontacts);
819 if (empty($contacts)) {
823 foreach ($contacts as $contact) {
824 $probed = Probe::uri($contact);
825 if (in_array($probed['network'], Protocol::FEDERATED)) {
826 $serverdata['network'] = $probed['network'];
831 $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
837 * Checks if the given server does have a '/poco' endpoint.
838 * This is used for the 'PortableContact' functionality,
839 * which is used by both Friendica and Hubzilla.
841 * @param string $url URL of the given server
842 * @param array $serverdata array with server data
844 * @return array server data
846 private static function checkPoCo(string $url, array $serverdata)
848 $serverdata['poco'] = '';
850 $curlResult = Network::curl($url. '/poco');
851 if (!$curlResult->isSuccess()) {
855 $data = json_decode($curlResult->getBody(), true);
860 if (!empty($data['totalResults'])) {
861 $registeredUsers = $serverdata['registered-users'] ?? 0;
862 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
863 $serverdata['directory-type'] = self::DT_POCO;
864 $serverdata['poco'] = $url . '/poco';
871 * Checks if the given server does have a Mastodon style directory endpoint.
873 * @param string $url URL of the given server
874 * @param array $serverdata array with server data
876 * @return array server data
878 public static function checkMastodonDirectory(string $url, array $serverdata)
880 $curlResult = Network::curl($url . '/api/v1/directory?limit=1');
881 if (!$curlResult->isSuccess()) {
885 $data = json_decode($curlResult->getBody(), true);
890 if (count($data) == 1) {
891 $serverdata['directory-type'] = self::DT_MASTODON;
898 * Detects the version number of a given server when it was a NextCloud installation
900 * @param string $url URL of the given server
901 * @param array $serverdata array with server data
903 * @return array server data
905 private static function detectNextcloud(string $url, array $serverdata)
907 $curlResult = Network::curl($url . '/status.php');
909 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
913 $data = json_decode($curlResult->getBody(), true);
918 if (!empty($data['version'])) {
919 $serverdata['platform'] = 'nextcloud';
920 $serverdata['version'] = $data['version'];
921 $serverdata['network'] = Protocol::ACTIVITYPUB;
928 * Detects data from a given server url if it was a mastodon alike system
930 * @param string $url URL of the given server
931 * @param array $serverdata array with server data
933 * @return array server data
935 private static function detectMastodonAlikes(string $url, array $serverdata)
937 $curlResult = Network::curl($url . '/api/v1/instance');
939 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
943 $data = json_decode($curlResult->getBody(), true);
948 if (!empty($data['version'])) {
949 $serverdata['platform'] = 'mastodon';
950 $serverdata['version'] = $data['version'] ?? '';
951 $serverdata['network'] = Protocol::ACTIVITYPUB;
954 if (!empty($data['title'])) {
955 $serverdata['site_name'] = $data['title'];
958 if (!empty($data['title']) && empty($serverdata['platform']) && empty($serverdata['network'])) {
959 $serverdata['platform'] = 'mastodon';
960 $serverdata['network'] = Protocol::ACTIVITYPUB;
963 if (!empty($data['description'])) {
964 $serverdata['info'] = trim($data['description']);
967 if (!empty($data['stats']['user_count'])) {
968 $serverdata['registered-users'] = $data['stats']['user_count'];
971 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
972 $serverdata['platform'] = strtolower($matches[1]);
973 $serverdata['version'] = $matches[2];
976 if (!empty($serverdata['version']) && strstr(strtolower($serverdata['version']), 'pleroma')) {
977 $serverdata['platform'] = 'pleroma';
978 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
981 if (!empty($serverdata['platform']) && strstr($serverdata['platform'], 'pleroma')) {
982 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['platform']));
983 $serverdata['platform'] = 'pleroma';
990 * Detects data from typical Hubzilla endpoints
992 * @param string $url URL of the given server
993 * @param array $serverdata array with server data
995 * @return array server data
997 private static function detectHubzilla(string $url, array $serverdata)
999 $curlResult = Network::curl($url . '/api/statusnet/config.json');
1000 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1004 $data = json_decode($curlResult->getBody(), true);
1009 if (!empty($data['site']['name'])) {
1010 $serverdata['site_name'] = $data['site']['name'];
1013 if (!empty($data['site']['platform'])) {
1014 $serverdata['platform'] = strtolower($data['site']['platform']['PLATFORM_NAME']);
1015 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
1016 $serverdata['network'] = Protocol::ZOT;
1019 if (!empty($data['site']['hubzilla'])) {
1020 $serverdata['platform'] = strtolower($data['site']['hubzilla']['PLATFORM_NAME']);
1021 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
1022 $serverdata['network'] = Protocol::ZOT;
1025 if (!empty($data['site']['redmatrix'])) {
1026 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
1027 $serverdata['platform'] = strtolower($data['site']['redmatrix']['PLATFORM_NAME']);
1028 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
1029 $serverdata['platform'] = strtolower($data['site']['redmatrix']['RED_PLATFORM']);
1032 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
1033 $serverdata['network'] = Protocol::ZOT;
1037 $inviteonly = false;
1040 if (!empty($data['site']['closed'])) {
1041 $closed = self::toBoolean($data['site']['closed']);
1044 if (!empty($data['site']['private'])) {
1045 $private = self::toBoolean($data['site']['private']);
1048 if (!empty($data['site']['inviteonly'])) {
1049 $inviteonly = self::toBoolean($data['site']['inviteonly']);
1052 if (!$closed && !$private and $inviteonly) {
1053 $register_policy = Register::APPROVE;
1054 } elseif (!$closed && !$private) {
1055 $register_policy = Register::OPEN;
1057 $register_policy = Register::CLOSED;
1064 * Converts input value to a boolean value
1066 * @param string|integer $val
1070 private static function toBoolean($val)
1072 if (($val == 'true') || ($val == 1)) {
1074 } elseif (($val == 'false') || ($val == 0)) {
1082 * Detect if the URL belongs to a GNU Social server
1084 * @param string $url URL of the given server
1085 * @param array $serverdata array with server data
1087 * @return array server data
1089 private static function detectGNUSocial(string $url, array $serverdata)
1091 // Test for GNU Social
1092 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
1093 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1094 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1095 $serverdata['platform'] = 'gnusocial';
1096 // Remove junk that some GNU Social servers return
1097 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
1098 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1099 $serverdata['version'] = trim($serverdata['version'], '"');
1100 $serverdata['network'] = Protocol::OSTATUS;
1104 // Test for Statusnet
1105 $curlResult = Network::curl($url . '/api/statusnet/version.json');
1106 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1107 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1109 // Remove junk that some GNU Social servers return
1110 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
1111 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1112 $serverdata['version'] = trim($serverdata['version'], '"');
1114 if (!empty($serverdata['version']) && strtolower(substr($serverdata['version'], 0, 7)) == 'pleroma') {
1115 $serverdata['platform'] = 'pleroma';
1116 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1117 $serverdata['network'] = Protocol::ACTIVITYPUB;
1119 $serverdata['platform'] = 'statusnet';
1120 $serverdata['network'] = Protocol::OSTATUS;
1128 * Detect if the URL belongs to a Friendica server
1130 * @param string $url URL of the given server
1131 * @param array $serverdata array with server data
1133 * @return array server data
1135 private static function detectFriendica(string $url, array $serverdata)
1137 $curlResult = Network::curl($url . '/friendica/json');
1138 if (!$curlResult->isSuccess()) {
1139 $curlResult = Network::curl($url . '/friendika/json');
1142 if (!$curlResult->isSuccess()) {
1146 $data = json_decode($curlResult->getBody(), true);
1147 if (empty($data) || empty($data['version'])) {
1151 $serverdata['network'] = Protocol::DFRN;
1152 $serverdata['version'] = $data['version'];
1154 if (!empty($data['no_scrape_url'])) {
1155 $serverdata['noscrape'] = $data['no_scrape_url'];
1158 if (!empty($data['site_name'])) {
1159 $serverdata['site_name'] = $data['site_name'];
1162 if (!empty($data['info'])) {
1163 $serverdata['info'] = trim($data['info']);
1166 $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
1167 switch ($register_policy) {
1168 case 'REGISTER_OPEN':
1169 $serverdata['register_policy'] = Register::OPEN;
1172 case 'REGISTER_APPROVE':
1173 $serverdata['register_policy'] = Register::APPROVE;
1176 case 'REGISTER_CLOSED':
1177 case 'REGISTER_INVITATION':
1178 $serverdata['register_policy'] = Register::CLOSED;
1181 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
1182 $serverdata['register_policy'] = Register::CLOSED;
1186 $serverdata['platform'] = strtolower($data['platform'] ?? '');
1192 * Analyses the landing page of a given server for hints about type and system of that server
1194 * @param object $curlResult result of curl execution
1195 * @param array $serverdata array with server data
1196 * @param string $url Server URL
1198 * @return array server data
1200 private static function analyseRootBody($curlResult, array $serverdata, string $url)
1202 $doc = new DOMDocument();
1203 @$doc->loadHTML($curlResult->getBody());
1204 $xpath = new DOMXPath($doc);
1206 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1207 if (!empty($title)) {
1208 $serverdata['site_name'] = $title;
1211 $list = $xpath->query('//meta[@name]');
1213 foreach ($list as $node) {
1215 if ($node->attributes->length) {
1216 foreach ($node->attributes as $attribute) {
1217 $value = trim($attribute->value);
1218 if (empty($value)) {
1222 $attr[$attribute->name] = $value;
1225 if (empty($attr['name']) || empty($attr['content'])) {
1230 if ($attr['name'] == 'description') {
1231 $serverdata['info'] = $attr['content'];
1234 if ($attr['name'] == 'application-name') {
1235 $serverdata['platform'] = strtolower($attr['content']);
1236 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1237 $serverdata['network'] = Protocol::ACTIVITYPUB;
1240 if (($attr['name'] == 'generator') && (empty($serverdata['platform']) || (substr(strtolower($attr['content']), 0, 9) == 'wordpress'))) {
1241 $serverdata['platform'] = strtolower($attr['content']);
1242 $version_part = explode(' ', $attr['content']);
1244 if (count($version_part) == 2) {
1245 if (in_array($version_part[0], ['WordPress'])) {
1246 $serverdata['platform'] = strtolower($version_part[0]);
1247 $serverdata['version'] = $version_part[1];
1249 // We still do need a reliable test if some AP plugin is activated
1250 if (DBA::exists('apcontact', ['baseurl' => $url])) {
1251 $serverdata['network'] = Protocol::ACTIVITYPUB;
1253 $serverdata['network'] = Protocol::FEED;
1256 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1257 $serverdata['platform'] = strtolower($version_part[0]);
1258 $serverdata['version'] = $version_part[1];
1259 $serverdata['network'] = Protocol::DFRN;
1265 $list = $xpath->query('//meta[@property]');
1267 foreach ($list as $node) {
1269 if ($node->attributes->length) {
1270 foreach ($node->attributes as $attribute) {
1271 $value = trim($attribute->value);
1272 if (empty($value)) {
1276 $attr[$attribute->name] = $value;
1279 if (empty($attr['property']) || empty($attr['content'])) {
1284 if ($attr['property'] == 'og:site_name') {
1285 $serverdata['site_name'] = $attr['content'];
1288 if ($attr['property'] == 'og:description') {
1289 $serverdata['info'] = $attr['content'];
1292 if ($attr['property'] == 'og:platform') {
1293 $serverdata['platform'] = strtolower($attr['content']);
1295 if (in_array($attr['content'], ['PeerTube'])) {
1296 $serverdata['network'] = Protocol::ACTIVITYPUB;
1300 if ($attr['property'] == 'generator') {
1301 $serverdata['platform'] = strtolower($attr['content']);
1303 if (in_array($attr['content'], ['hubzilla'])) {
1304 // We later check which compatible protocol modules are loaded.
1305 $serverdata['network'] = Protocol::ZOT;
1314 * Analyses the header data of a given server for hints about type and system of that server
1316 * @param object $curlResult result of curl execution
1317 * @param array $serverdata array with server data
1319 * @return array server data
1321 private static function analyseRootHeader($curlResult, array $serverdata)
1323 if ($curlResult->getHeader('server') == 'Mastodon') {
1324 $serverdata['platform'] = 'mastodon';
1325 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
1326 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1327 $serverdata['platform'] = 'diaspora';
1328 $serverdata['network'] = $network = Protocol::DIASPORA;
1329 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
1330 } elseif ($curlResult->inHeader('x-friendica-version')) {
1331 $serverdata['platform'] = 'friendica';
1332 $serverdata['network'] = $network = Protocol::DFRN;
1333 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');
1339 * Test if the body contains valid content
1341 * @param string $body
1344 private static function invalidBody(string $body)
1346 // Currently we only test for a HTML element.
1347 // Possibly we enhance this in the future.
1348 return !strpos($body, '>');
1352 * Update the user directory of a given gserver record
1354 * @param array $gserver gserver record
1356 public static function updateDirectory(array $gserver)
1358 /// @todo Add Mastodon API directory
1360 if (!empty($gserver['poco'])) {
1361 PortableContact::discoverSingleServer($gserver['id']);
1366 * Update GServer entries
1368 public static function discover()
1370 // Update the server list
1371 self::discoverFederation();
1375 $requery_days = intval(DI::config()->get('system', 'poco_requery_days'));
1377 if ($requery_days == 0) {
1381 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
1383 $gservers = DBA::p("SELECT `id`, `url`, `nurl`, `network`, `poco`
1385 WHERE `last_contact` >= `last_failure`
1387 AND `last_poco_query` < ?
1388 ORDER BY RAND()", $last_update
1391 while ($gserver = DBA::fetch($gservers)) {
1392 if (!GServer::check($gserver['url'], $gserver['network'])) {
1393 // The server is not reachable? Okay, then we will try it later
1394 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
1395 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
1399 Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
1400 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
1402 if (--$no_of_queries == 0) {
1407 DBA::close($gservers);
1411 * Discover federated servers
1413 private static function discoverFederation()
1415 $last = DI::config()->get('poco', 'last_federation_discovery');
1418 $next = $last + (24 * 60 * 60);
1420 if ($next > time()) {
1425 // Discover federated servers
1426 $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
1428 if (!empty($curlResult)) {
1429 $servers = json_decode($curlResult, true);
1431 if (!empty($servers['pods'])) {
1432 foreach ($servers['pods'] as $server) {
1433 Worker::add(PRIORITY_LOW, 'UpdateGServer', 'https://' . $server['host']);
1438 // Disvover Mastodon servers
1439 $accesstoken = DI::config()->get('system', 'instances_social_key');
1441 if (!empty($accesstoken)) {
1442 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1443 $header = ['Authorization: Bearer '.$accesstoken];
1444 $curlResult = Network::curl($api, false, ['headers' => $header]);
1446 if ($curlResult->isSuccess()) {
1447 $servers = json_decode($curlResult->getBody(), true);
1449 foreach ($servers['instances'] as $server) {
1450 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
1451 Worker::add(PRIORITY_LOW, 'UpdateGServer', $url);
1456 DI::config()->set('poco', 'last_federation_discovery', time());