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.
134 * @param boolean $only_nodeinfo Only use nodeinfo for server detection
136 * @return boolean 'true' if server seems vital
138 public static function check(string $server_url, string $network = '', bool $force = false, bool $only_nodeinfo = false)
140 // Unify the server address
141 $server_url = trim($server_url, '/');
142 $server_url = str_replace('/index.php', '', $server_url);
144 if ($server_url == '') {
148 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
149 if (DBA::isResult($gserver)) {
150 if ($gserver['created'] <= DBA::NULL_DATETIME) {
151 $fields = ['created' => DateTimeFormat::utcNow()];
152 $condition = ['nurl' => Strings::normaliseLink($server_url)];
153 DBA::update('gserver', $fields, $condition);
156 $last_contact = $gserver['last_contact'];
157 $last_failure = $gserver['last_failure'];
159 // See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
160 // It can happen that a zero date is in the database, but storing it again is forbidden.
161 if ($last_contact < DBA::NULL_DATETIME) {
162 $last_contact = DBA::NULL_DATETIME;
165 if ($last_failure < DBA::NULL_DATETIME) {
166 $last_failure = DBA::NULL_DATETIME;
169 if (!$force && !self::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
170 Logger::info('No update needed', ['server' => $server_url]);
171 return ($last_contact >= $last_failure);
173 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
175 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
178 return self::detect($server_url, $network, $only_nodeinfo);
182 * Set failed server status
186 private static function setFailure(string $url)
188 if (DBA::exists('gserver', ['nurl' => Strings::normaliseLink($url)])) {
189 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
190 Logger::info('Set failed status for existing server', ['url' => $url]);
193 DBA::insert('gserver', ['url' => $url, 'nurl' => Strings::normaliseLink($url),
194 'network' => Protocol::PHANTOM, 'created' => DateTimeFormat::utcNow(),
195 'last_failure' => DateTimeFormat::utcNow()]);
196 Logger::info('Set failed status for new server', ['url' => $url]);
200 * Detect server data (type, protocol, version number, ...)
201 * The detected data is then updated or inserted in the gserver table.
203 * @param string $url URL of the given server
204 * @param string $network Network value that is used, when detection failed
205 * @param boolean $only_nodeinfo Only use nodeinfo for server detection
207 * @return boolean 'true' if server could be detected
209 public static function detect(string $url, string $network = '', bool $only_nodeinfo = false)
211 Logger::info('Detect server type', ['server' => $url]);
214 $original_url = $url;
216 // Remove URL content that is not supposed to exist for a server url
217 $urlparts = parse_url($url);
218 unset($urlparts['user']);
219 unset($urlparts['pass']);
220 unset($urlparts['query']);
221 unset($urlparts['fragment']);
222 $url = Network::unparseURL($urlparts);
224 // If the URL missmatches, then we mark the old entry as failure
225 if ($url != $original_url) {
226 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($original_url)]);
229 // When a nodeinfo is present, we don't need to dig further
230 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
231 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
232 if ($curlResult->isTimeout()) {
233 self::setFailure($url);
237 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
238 if ($only_nodeinfo && empty($nodeinfo)) {
239 Logger::info('Invalid nodeinfo in nodeinfo-mode, server is marked as failure', ['url' => $url]);
240 self::setFailure($url);
244 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
245 if (empty($nodeinfo)) {
246 $nodeinfo = self::fetchStatistics($url);
249 // If that didn't work out well, we use some protocol specific endpoints
250 // For Friendica and Zot based networks we have to dive deeper to reveal more details
251 if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
252 // Fetch the landing page, possibly it reveals some data
253 if (empty($nodeinfo['network'])) {
254 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
255 if ($curlResult->isSuccess()) {
256 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
257 $serverdata = self::analyseRootBody($curlResult, $serverdata, $url);
260 if (!$curlResult->isSuccess() || empty($curlResult->getBody()) || self::invalidBody($curlResult->getBody())) {
261 self::setFailure($url);
266 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
267 $serverdata = self::detectMastodonAlikes($url, $serverdata);
270 // All following checks are done for systems that always have got a "host-meta" endpoint.
271 // With this check we don't have to waste time and ressources for dead systems.
272 // Also this hopefully prevents us from receiving abuse messages.
273 if (empty($serverdata['network']) && !self::validHostMeta($url)) {
274 self::setFailure($url);
278 if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
279 $serverdata = self::detectFriendica($url, $serverdata);
282 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
283 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
284 $serverdata = self::fetchSiteinfo($url, $serverdata);
287 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
288 if (empty($serverdata['network'])) {
289 $serverdata = self::detectHubzilla($url, $serverdata);
292 if (empty($serverdata['network'])) {
293 $serverdata = self::detectNextcloud($url, $serverdata);
296 if (empty($serverdata['network'])) {
297 $serverdata = self::detectGNUSocial($url, $serverdata);
300 $serverdata = $nodeinfo;
303 // Detect the directory type
304 $serverdata['directory-type'] = self::DT_NONE;
305 $serverdata = self::checkPoCo($url, $serverdata);
306 $serverdata = self::checkMastodonDirectory($url, $serverdata);
308 // We can't detect the network type. Possibly it is some system that we don't know yet
309 if (empty($serverdata['network'])) {
310 $serverdata['network'] = Protocol::PHANTOM;
313 // When we hadn't been able to detect the network type, we use the hint from the parameter
314 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
315 $serverdata['network'] = $network;
318 $serverdata['url'] = $url;
319 $serverdata['nurl'] = Strings::normaliseLink($url);
321 // We take the highest number that we do find
322 $registeredUsers = $serverdata['registered-users'] ?? 0;
324 // On an active server there has to be at least a single user
325 if (($serverdata['network'] != Protocol::PHANTOM) && ($registeredUsers == 0)) {
326 $registeredUsers = 1;
329 if ($serverdata['network'] != Protocol::PHANTOM) {
330 $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
331 $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
332 $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
333 $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
335 $serverdata['registered-users'] = $registeredUsers;
336 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
339 $serverdata['last_contact'] = DateTimeFormat::utcNow();
341 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
342 if (!DBA::isResult($gserver)) {
343 $serverdata['created'] = DateTimeFormat::utcNow();
344 $ret = DBA::insert('gserver', $serverdata);
346 // Don't override the network with 'unknown' when there had been a valid entry before
347 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
348 unset($serverdata['network']);
351 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
354 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
355 self::discoverRelay($url);
362 * Fetch relay data from a given server url
364 * @param string $server_url address of the server
365 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
367 private static function discoverRelay(string $server_url)
369 Logger::info('Discover relay data', ['server' => $server_url]);
371 $curlResult = Network::curl($server_url . '/.well-known/x-social-relay');
372 if (!$curlResult->isSuccess()) {
376 $data = json_decode($curlResult->getBody(), true);
377 if (!is_array($data)) {
381 // Sanitize incoming data, see https://github.com/friendica/friendica/issues/8565
382 $data['subscribe'] = (bool)$data['subscribe'] ?? false;
384 if (!$data['subscribe'] || empty($data['scope']) || !in_array(strtolower($data['scope']), ['all', 'tags'])) {
386 $data['subscribe'] = false;
390 $gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
391 if (!DBA::isResult($gserver)) {
395 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
396 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
397 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
400 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
402 if ($data['scope'] == 'tags') {
405 foreach ($data['tags'] as $tag) {
406 $tag = mb_strtolower($tag);
407 if (strlen($tag) < 100) {
412 foreach ($tags as $tag) {
413 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], true);
417 // Create or update the relay contact
419 if (isset($data['protocols'])) {
420 if (isset($data['protocols']['diaspora'])) {
421 $fields['network'] = Protocol::DIASPORA;
423 if (isset($data['protocols']['diaspora']['receive'])) {
424 $fields['batch'] = $data['protocols']['diaspora']['receive'];
425 } elseif (is_string($data['protocols']['diaspora'])) {
426 $fields['batch'] = $data['protocols']['diaspora'];
430 if (isset($data['protocols']['dfrn'])) {
431 $fields['network'] = Protocol::DFRN;
433 if (isset($data['protocols']['dfrn']['receive'])) {
434 $fields['batch'] = $data['protocols']['dfrn']['receive'];
435 } elseif (is_string($data['protocols']['dfrn'])) {
436 $fields['batch'] = $data['protocols']['dfrn'];
440 Diaspora::setRelayContact($server_url, $fields);
444 * Fetch server data from '/statistics.json' on the given server
446 * @param string $url URL of the given server
448 * @return array server data
450 private static function fetchStatistics(string $url)
452 $curlResult = Network::curl($url . '/statistics.json');
453 if (!$curlResult->isSuccess()) {
457 $data = json_decode($curlResult->getBody(), true);
464 if (!empty($data['version'])) {
465 $serverdata['version'] = $data['version'];
466 // Version numbers on statistics.json are presented with additional info, e.g.:
467 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
468 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
471 if (!empty($data['name'])) {
472 $serverdata['site_name'] = $data['name'];
475 if (!empty($data['network'])) {
476 $serverdata['platform'] = strtolower($data['network']);
478 if ($serverdata['platform'] == 'diaspora') {
479 $serverdata['network'] = Protocol::DIASPORA;
480 } elseif ($serverdata['platform'] == 'friendica') {
481 $serverdata['network'] = Protocol::DFRN;
482 } elseif ($serverdata['platform'] == 'hubzilla') {
483 $serverdata['network'] = Protocol::ZOT;
484 } elseif ($serverdata['platform'] == 'redmatrix') {
485 $serverdata['network'] = Protocol::ZOT;
490 if (!empty($data['registrations_open'])) {
491 $serverdata['register_policy'] = Register::OPEN;
493 $serverdata['register_policy'] = Register::CLOSED;
500 * Detect server type by using the nodeinfo data
502 * @param string $url address of the server
503 * @param CurlResult $curlResult
504 * @return array Server data
505 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
507 private static function fetchNodeinfo(string $url, CurlResult $curlResult)
509 if (!$curlResult->isSuccess()) {
513 $nodeinfo = json_decode($curlResult->getBody(), true);
515 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
522 foreach ($nodeinfo['links'] as $link) {
523 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
524 Logger::info('Invalid nodeinfo format', ['url' => $url]);
527 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
528 $nodeinfo1_url = $link['href'];
529 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
530 $nodeinfo2_url = $link['href'];
534 if ($nodeinfo1_url . $nodeinfo2_url == '') {
540 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
541 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
542 $server = self::parseNodeinfo2($nodeinfo2_url);
545 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
546 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
547 $server = self::parseNodeinfo1($nodeinfo1_url);
556 * @param string $nodeinfo_url address of the nodeinfo path
557 * @return array Server data
558 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
560 private static function parseNodeinfo1(string $nodeinfo_url)
562 $curlResult = Network::curl($nodeinfo_url);
564 if (!$curlResult->isSuccess()) {
568 $nodeinfo = json_decode($curlResult->getBody(), true);
570 if (!is_array($nodeinfo)) {
576 $server['register_policy'] = Register::CLOSED;
578 if (!empty($nodeinfo['openRegistrations'])) {
579 $server['register_policy'] = Register::OPEN;
582 if (is_array($nodeinfo['software'])) {
583 if (!empty($nodeinfo['software']['name'])) {
584 $server['platform'] = strtolower($nodeinfo['software']['name']);
587 if (!empty($nodeinfo['software']['version'])) {
588 $server['version'] = $nodeinfo['software']['version'];
589 // Version numbers on Nodeinfo are presented with additional info, e.g.:
590 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
591 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
595 if (!empty($nodeinfo['metadata']['nodeName'])) {
596 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
599 if (!empty($nodeinfo['usage']['users']['total'])) {
600 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
603 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
605 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
606 $protocols[$protocol] = true;
609 if (!empty($protocols['friendica'])) {
610 $server['network'] = Protocol::DFRN;
611 } elseif (!empty($protocols['activitypub'])) {
612 $server['network'] = Protocol::ACTIVITYPUB;
613 } elseif (!empty($protocols['diaspora'])) {
614 $server['network'] = Protocol::DIASPORA;
615 } elseif (!empty($protocols['ostatus'])) {
616 $server['network'] = Protocol::OSTATUS;
617 } elseif (!empty($protocols['gnusocial'])) {
618 $server['network'] = Protocol::OSTATUS;
619 } elseif (!empty($protocols['zot'])) {
620 $server['network'] = Protocol::ZOT;
624 if (empty($server)) {
634 * @param string $nodeinfo_url address of the nodeinfo path
635 * @return array Server data
636 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
638 private static function parseNodeinfo2(string $nodeinfo_url)
640 $curlResult = Network::curl($nodeinfo_url);
641 if (!$curlResult->isSuccess()) {
645 $nodeinfo = json_decode($curlResult->getBody(), true);
647 if (!is_array($nodeinfo)) {
653 $server['register_policy'] = Register::CLOSED;
655 if (!empty($nodeinfo['openRegistrations'])) {
656 $server['register_policy'] = Register::OPEN;
659 if (is_array($nodeinfo['software'])) {
660 if (!empty($nodeinfo['software']['name'])) {
661 $server['platform'] = strtolower($nodeinfo['software']['name']);
664 if (!empty($nodeinfo['software']['version'])) {
665 $server['version'] = $nodeinfo['software']['version'];
666 // Version numbers on Nodeinfo are presented with additional info, e.g.:
667 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
668 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
672 if (!empty($nodeinfo['metadata']['nodeName'])) {
673 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
676 if (!empty($nodeinfo['usage']['users']['total'])) {
677 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
680 if (!empty($nodeinfo['protocols'])) {
682 foreach ($nodeinfo['protocols'] as $protocol) {
683 $protocols[$protocol] = true;
686 if (!empty($protocols['dfrn'])) {
687 $server['network'] = Protocol::DFRN;
688 } elseif (!empty($protocols['activitypub'])) {
689 $server['network'] = Protocol::ACTIVITYPUB;
690 } elseif (!empty($protocols['diaspora'])) {
691 $server['network'] = Protocol::DIASPORA;
692 } elseif (!empty($protocols['ostatus'])) {
693 $server['network'] = Protocol::OSTATUS;
694 } elseif (!empty($protocols['gnusocial'])) {
695 $server['network'] = Protocol::OSTATUS;
696 } elseif (!empty($protocols['zot'])) {
697 $server['network'] = Protocol::ZOT;
701 if (empty($server)) {
709 * Fetch server information from a 'siteinfo.json' file on the given server
711 * @param string $url URL of the given server
712 * @param array $serverdata array with server data
714 * @return array server data
716 private static function fetchSiteinfo(string $url, array $serverdata)
718 $curlResult = Network::curl($url . '/siteinfo.json');
719 if (!$curlResult->isSuccess()) {
723 $data = json_decode($curlResult->getBody(), true);
728 if (!empty($data['url'])) {
729 $serverdata['platform'] = strtolower($data['platform']);
730 $serverdata['version'] = $data['version'];
733 if (!empty($data['plugins'])) {
734 if (in_array('pubcrawl', $data['plugins'])) {
735 $serverdata['network'] = Protocol::ACTIVITYPUB;
736 } elseif (in_array('diaspora', $data['plugins'])) {
737 $serverdata['network'] = Protocol::DIASPORA;
738 } elseif (in_array('gnusoc', $data['plugins'])) {
739 $serverdata['network'] = Protocol::OSTATUS;
741 $serverdata['network'] = Protocol::ZOT;
745 if (!empty($data['site_name'])) {
746 $serverdata['site_name'] = $data['site_name'];
749 if (!empty($data['channels_total'])) {
750 $serverdata['registered-users'] = $data['channels_total'];
753 if (!empty($data['register_policy'])) {
754 switch ($data['register_policy']) {
755 case 'REGISTER_OPEN':
756 $serverdata['register_policy'] = Register::OPEN;
759 case 'REGISTER_APPROVE':
760 $serverdata['register_policy'] = Register::APPROVE;
763 case 'REGISTER_CLOSED':
765 $serverdata['register_policy'] = Register::CLOSED;
774 * Checks if the server contains a valid host meta file
776 * @param string $url URL of the given server
778 * @return boolean 'true' if the server seems to be vital
780 private static function validHostMeta(string $url)
782 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
783 $curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
784 if (!$curlResult->isSuccess()) {
788 $xrd = XML::parseString($curlResult->getBody());
789 if (!is_object($xrd)) {
793 $elements = XML::elementToArray($xrd);
794 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
799 foreach ($elements['xrd']['link'] as $link) {
800 // When there is more than a single "link" element, the array looks slightly different
801 if (!empty($link['@attributes'])) {
802 $link = $link['@attributes'];
805 if (empty($link['rel']) || empty($link['template'])) {
809 if ($link['rel'] == 'lrdd') {
810 // When the webfinger host is the same like the system host, it should be ok.
811 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
819 * Detect the network of the given server via their known contacts
821 * @param string $url URL of the given server
822 * @param array $serverdata array with server data
824 * @return array server data
826 private static function detectNetworkViaContacts(string $url, array $serverdata)
830 $gcontacts = DBA::select('gcontact', ['url', 'nurl'], ['server_url' => [$url, $serverdata['nurl']]]);
831 while ($gcontact = DBA::fetch($gcontacts)) {
832 $contacts[$gcontact['nurl']] = $gcontact['url'];
834 DBA::close($gcontacts);
836 $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
837 while ($apcontact = DBA::fetch($apcontacts)) {
838 $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
840 DBA::close($apcontacts);
842 $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
843 while ($pcontact = DBA::fetch($pcontacts)) {
844 $contacts[$pcontact['nurl']] = $pcontact['url'];
846 DBA::close($pcontacts);
848 if (empty($contacts)) {
852 foreach ($contacts as $contact) {
853 $probed = Probe::uri($contact);
854 if (in_array($probed['network'], Protocol::FEDERATED)) {
855 $serverdata['network'] = $probed['network'];
860 $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
866 * Checks if the given server does have a '/poco' endpoint.
867 * This is used for the 'PortableContact' functionality,
868 * which is used by both Friendica and Hubzilla.
870 * @param string $url URL of the given server
871 * @param array $serverdata array with server data
873 * @return array server data
875 private static function checkPoCo(string $url, array $serverdata)
877 $serverdata['poco'] = '';
879 $curlResult = Network::curl($url. '/poco');
880 if (!$curlResult->isSuccess()) {
884 $data = json_decode($curlResult->getBody(), true);
889 if (!empty($data['totalResults'])) {
890 $registeredUsers = $serverdata['registered-users'] ?? 0;
891 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
892 $serverdata['directory-type'] = self::DT_POCO;
893 $serverdata['poco'] = $url . '/poco';
900 * Checks if the given server does have a Mastodon style directory endpoint.
902 * @param string $url URL of the given server
903 * @param array $serverdata array with server data
905 * @return array server data
907 public static function checkMastodonDirectory(string $url, array $serverdata)
909 $curlResult = Network::curl($url . '/api/v1/directory?limit=1');
910 if (!$curlResult->isSuccess()) {
914 $data = json_decode($curlResult->getBody(), true);
919 if (count($data) == 1) {
920 $serverdata['directory-type'] = self::DT_MASTODON;
927 * Detects the version number of a given server when it was a NextCloud installation
929 * @param string $url URL of the given server
930 * @param array $serverdata array with server data
932 * @return array server data
934 private static function detectNextcloud(string $url, array $serverdata)
936 $curlResult = Network::curl($url . '/status.php');
938 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
942 $data = json_decode($curlResult->getBody(), true);
947 if (!empty($data['version'])) {
948 $serverdata['platform'] = 'nextcloud';
949 $serverdata['version'] = $data['version'];
950 $serverdata['network'] = Protocol::ACTIVITYPUB;
957 * Detects data from a given server url if it was a mastodon alike system
959 * @param string $url URL of the given server
960 * @param array $serverdata array with server data
962 * @return array server data
964 private static function detectMastodonAlikes(string $url, array $serverdata)
966 $curlResult = Network::curl($url . '/api/v1/instance');
968 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
972 $data = json_decode($curlResult->getBody(), true);
977 if (!empty($data['version'])) {
978 $serverdata['platform'] = 'mastodon';
979 $serverdata['version'] = $data['version'] ?? '';
980 $serverdata['network'] = Protocol::ACTIVITYPUB;
983 if (!empty($data['title'])) {
984 $serverdata['site_name'] = $data['title'];
987 if (!empty($data['title']) && empty($serverdata['platform']) && empty($serverdata['network'])) {
988 $serverdata['platform'] = 'mastodon';
989 $serverdata['network'] = Protocol::ACTIVITYPUB;
992 if (!empty($data['description'])) {
993 $serverdata['info'] = trim($data['description']);
996 if (!empty($data['stats']['user_count'])) {
997 $serverdata['registered-users'] = $data['stats']['user_count'];
1000 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
1001 $serverdata['platform'] = strtolower($matches[1]);
1002 $serverdata['version'] = $matches[2];
1005 if (!empty($serverdata['version']) && strstr(strtolower($serverdata['version']), 'pleroma')) {
1006 $serverdata['platform'] = 'pleroma';
1007 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1010 if (!empty($serverdata['platform']) && strstr($serverdata['platform'], 'pleroma')) {
1011 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['platform']));
1012 $serverdata['platform'] = 'pleroma';
1019 * Detects data from typical Hubzilla endpoints
1021 * @param string $url URL of the given server
1022 * @param array $serverdata array with server data
1024 * @return array server data
1026 private static function detectHubzilla(string $url, array $serverdata)
1028 $curlResult = Network::curl($url . '/api/statusnet/config.json');
1029 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
1033 $data = json_decode($curlResult->getBody(), true);
1038 if (!empty($data['site']['name'])) {
1039 $serverdata['site_name'] = $data['site']['name'];
1042 if (!empty($data['site']['platform'])) {
1043 $serverdata['platform'] = strtolower($data['site']['platform']['PLATFORM_NAME']);
1044 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
1045 $serverdata['network'] = Protocol::ZOT;
1048 if (!empty($data['site']['hubzilla'])) {
1049 $serverdata['platform'] = strtolower($data['site']['hubzilla']['PLATFORM_NAME']);
1050 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
1051 $serverdata['network'] = Protocol::ZOT;
1054 if (!empty($data['site']['redmatrix'])) {
1055 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
1056 $serverdata['platform'] = strtolower($data['site']['redmatrix']['PLATFORM_NAME']);
1057 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
1058 $serverdata['platform'] = strtolower($data['site']['redmatrix']['RED_PLATFORM']);
1061 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
1062 $serverdata['network'] = Protocol::ZOT;
1066 $inviteonly = false;
1069 if (!empty($data['site']['closed'])) {
1070 $closed = self::toBoolean($data['site']['closed']);
1073 if (!empty($data['site']['private'])) {
1074 $private = self::toBoolean($data['site']['private']);
1077 if (!empty($data['site']['inviteonly'])) {
1078 $inviteonly = self::toBoolean($data['site']['inviteonly']);
1081 if (!$closed && !$private and $inviteonly) {
1082 $register_policy = Register::APPROVE;
1083 } elseif (!$closed && !$private) {
1084 $register_policy = Register::OPEN;
1086 $register_policy = Register::CLOSED;
1093 * Converts input value to a boolean value
1095 * @param string|integer $val
1099 private static function toBoolean($val)
1101 if (($val == 'true') || ($val == 1)) {
1103 } elseif (($val == 'false') || ($val == 0)) {
1111 * Detect if the URL belongs to a GNU Social server
1113 * @param string $url URL of the given server
1114 * @param array $serverdata array with server data
1116 * @return array server data
1118 private static function detectGNUSocial(string $url, array $serverdata)
1120 // Test for GNU Social
1121 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
1122 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1123 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1124 $serverdata['platform'] = 'gnusocial';
1125 // Remove junk that some GNU Social servers return
1126 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
1127 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1128 $serverdata['version'] = trim($serverdata['version'], '"');
1129 $serverdata['network'] = Protocol::OSTATUS;
1133 // Test for Statusnet
1134 $curlResult = Network::curl($url . '/api/statusnet/version.json');
1135 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1136 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1138 // Remove junk that some GNU Social servers return
1139 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
1140 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1141 $serverdata['version'] = trim($serverdata['version'], '"');
1143 if (!empty($serverdata['version']) && strtolower(substr($serverdata['version'], 0, 7)) == 'pleroma') {
1144 $serverdata['platform'] = 'pleroma';
1145 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1146 $serverdata['network'] = Protocol::ACTIVITYPUB;
1148 $serverdata['platform'] = 'statusnet';
1149 $serverdata['network'] = Protocol::OSTATUS;
1157 * Detect if the URL belongs to a Friendica server
1159 * @param string $url URL of the given server
1160 * @param array $serverdata array with server data
1162 * @return array server data
1164 private static function detectFriendica(string $url, array $serverdata)
1166 $curlResult = Network::curl($url . '/friendica/json');
1167 if (!$curlResult->isSuccess()) {
1168 $curlResult = Network::curl($url . '/friendika/json');
1171 if (!$curlResult->isSuccess()) {
1175 $data = json_decode($curlResult->getBody(), true);
1176 if (empty($data) || empty($data['version'])) {
1180 $serverdata['network'] = Protocol::DFRN;
1181 $serverdata['version'] = $data['version'];
1183 if (!empty($data['no_scrape_url'])) {
1184 $serverdata['noscrape'] = $data['no_scrape_url'];
1187 if (!empty($data['site_name'])) {
1188 $serverdata['site_name'] = $data['site_name'];
1191 if (!empty($data['info'])) {
1192 $serverdata['info'] = trim($data['info']);
1195 $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
1196 switch ($register_policy) {
1197 case 'REGISTER_OPEN':
1198 $serverdata['register_policy'] = Register::OPEN;
1201 case 'REGISTER_APPROVE':
1202 $serverdata['register_policy'] = Register::APPROVE;
1205 case 'REGISTER_CLOSED':
1206 case 'REGISTER_INVITATION':
1207 $serverdata['register_policy'] = Register::CLOSED;
1210 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
1211 $serverdata['register_policy'] = Register::CLOSED;
1215 $serverdata['platform'] = strtolower($data['platform'] ?? '');
1221 * Analyses the landing page of a given server for hints about type and system of that server
1223 * @param object $curlResult result of curl execution
1224 * @param array $serverdata array with server data
1225 * @param string $url Server URL
1227 * @return array server data
1229 private static function analyseRootBody($curlResult, array $serverdata, string $url)
1231 $doc = new DOMDocument();
1232 @$doc->loadHTML($curlResult->getBody());
1233 $xpath = new DOMXPath($doc);
1235 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1236 if (!empty($title)) {
1237 $serverdata['site_name'] = $title;
1240 $list = $xpath->query('//meta[@name]');
1242 foreach ($list as $node) {
1244 if ($node->attributes->length) {
1245 foreach ($node->attributes as $attribute) {
1246 $value = trim($attribute->value);
1247 if (empty($value)) {
1251 $attr[$attribute->name] = $value;
1254 if (empty($attr['name']) || empty($attr['content'])) {
1259 if ($attr['name'] == 'description') {
1260 $serverdata['info'] = $attr['content'];
1263 if ($attr['name'] == 'application-name') {
1264 $serverdata['platform'] = strtolower($attr['content']);
1265 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1266 $serverdata['network'] = Protocol::ACTIVITYPUB;
1269 if (($attr['name'] == 'generator') && (empty($serverdata['platform']) || (substr(strtolower($attr['content']), 0, 9) == 'wordpress'))) {
1270 $serverdata['platform'] = strtolower($attr['content']);
1271 $version_part = explode(' ', $attr['content']);
1273 if (count($version_part) == 2) {
1274 if (in_array($version_part[0], ['WordPress'])) {
1275 $serverdata['platform'] = strtolower($version_part[0]);
1276 $serverdata['version'] = $version_part[1];
1278 // We still do need a reliable test if some AP plugin is activated
1279 if (DBA::exists('apcontact', ['baseurl' => $url])) {
1280 $serverdata['network'] = Protocol::ACTIVITYPUB;
1282 $serverdata['network'] = Protocol::FEED;
1285 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1286 $serverdata['platform'] = strtolower($version_part[0]);
1287 $serverdata['version'] = $version_part[1];
1288 $serverdata['network'] = Protocol::DFRN;
1294 $list = $xpath->query('//meta[@property]');
1296 foreach ($list as $node) {
1298 if ($node->attributes->length) {
1299 foreach ($node->attributes as $attribute) {
1300 $value = trim($attribute->value);
1301 if (empty($value)) {
1305 $attr[$attribute->name] = $value;
1308 if (empty($attr['property']) || empty($attr['content'])) {
1313 if ($attr['property'] == 'og:site_name') {
1314 $serverdata['site_name'] = $attr['content'];
1317 if ($attr['property'] == 'og:description') {
1318 $serverdata['info'] = $attr['content'];
1321 if ($attr['property'] == 'og:platform') {
1322 $serverdata['platform'] = strtolower($attr['content']);
1324 if (in_array($attr['content'], ['PeerTube'])) {
1325 $serverdata['network'] = Protocol::ACTIVITYPUB;
1329 if ($attr['property'] == 'generator') {
1330 $serverdata['platform'] = strtolower($attr['content']);
1332 if (in_array($attr['content'], ['hubzilla'])) {
1333 // We later check which compatible protocol modules are loaded.
1334 $serverdata['network'] = Protocol::ZOT;
1343 * Analyses the header data of a given server for hints about type and system of that server
1345 * @param object $curlResult result of curl execution
1346 * @param array $serverdata array with server data
1348 * @return array server data
1350 private static function analyseRootHeader($curlResult, array $serverdata)
1352 if ($curlResult->getHeader('server') == 'Mastodon') {
1353 $serverdata['platform'] = 'mastodon';
1354 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
1355 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1356 $serverdata['platform'] = 'diaspora';
1357 $serverdata['network'] = $network = Protocol::DIASPORA;
1358 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
1359 } elseif ($curlResult->inHeader('x-friendica-version')) {
1360 $serverdata['platform'] = 'friendica';
1361 $serverdata['network'] = $network = Protocol::DFRN;
1362 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');
1368 * Test if the body contains valid content
1370 * @param string $body
1373 private static function invalidBody(string $body)
1375 // Currently we only test for a HTML element.
1376 // Possibly we enhance this in the future.
1377 return !strpos($body, '>');
1381 * Update the user directory of a given gserver record
1383 * @param array $gserver gserver record
1385 public static function updateDirectory(array $gserver)
1387 /// @todo Add Mastodon API directory
1389 if (!empty($gserver['poco'])) {
1390 PortableContact::discoverSingleServer($gserver['id']);
1395 * Update GServer entries
1397 public static function discover()
1399 // Update the server list
1400 self::discoverFederation();
1404 $requery_days = intval(DI::config()->get('system', 'poco_requery_days'));
1406 if ($requery_days == 0) {
1410 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
1412 $gservers = DBA::p("SELECT `id`, `url`, `nurl`, `network`, `poco`
1414 WHERE `last_contact` >= `last_failure`
1416 AND `last_poco_query` < ?
1417 ORDER BY RAND()", $last_update
1420 while ($gserver = DBA::fetch($gservers)) {
1421 if (!GServer::check($gserver['url'], $gserver['network'])) {
1422 // The server is not reachable? Okay, then we will try it later
1423 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
1424 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
1428 Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
1429 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
1431 if (--$no_of_queries == 0) {
1436 DBA::close($gservers);
1440 * Discover federated servers
1442 private static function discoverFederation()
1444 $last = DI::config()->get('poco', 'last_federation_discovery');
1447 $next = $last + (24 * 60 * 60);
1449 if ($next > time()) {
1454 // Discover federated servers
1455 $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
1457 if (!empty($curlResult)) {
1458 $servers = json_decode($curlResult, true);
1460 if (!empty($servers['pods'])) {
1461 foreach ($servers['pods'] as $server) {
1462 // Using "only_nodeinfo" since servers that are listed on that page should always have it.
1463 Worker::add(PRIORITY_LOW, 'UpdateGServer', 'https://' . $server['host'], true);
1468 // Disvover Mastodon servers
1469 $accesstoken = DI::config()->get('system', 'instances_social_key');
1471 if (!empty($accesstoken)) {
1472 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1473 $header = ['Authorization: Bearer '.$accesstoken];
1474 $curlResult = Network::curl($api, false, ['headers' => $header]);
1476 if ($curlResult->isSuccess()) {
1477 $servers = json_decode($curlResult->getBody(), true);
1479 foreach ($servers['instances'] as $server) {
1480 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
1481 Worker::add(PRIORITY_LOW, 'UpdateGServer', $url);
1486 DI::config()->set('poco', 'last_federation_discovery', time());