4 * @file src/Model/GServer.php
5 * This file includes the GServer class to handle with servers
7 namespace Friendica\Model;
11 use Friendica\Core\Config;
12 use Friendica\Core\Protocol;
13 use Friendica\Database\DBA;
14 use Friendica\Module\Register;
15 use Friendica\Util\Network;
16 use Friendica\Util\DateTimeFormat;
17 use Friendica\Util\Strings;
18 use Friendica\Util\XML;
19 use Friendica\Core\Logger;
20 use Friendica\Protocol\PortableContact;
21 use Friendica\Protocol\Diaspora;
22 use Friendica\Network\Probe;
25 * This class handles GServer related functions
30 * Checks if the given server is reachable
32 * @param string $profile URL of the given profile
33 * @param string $server URL of the given server (If empty, taken from profile)
34 * @param string $network Network value that is used, when detection failed
35 * @param boolean $force Force an update.
37 * @return boolean 'true' if server seems vital
39 public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false)
42 $server = Contact::getBasepath($profile);
49 return self::check($server, $network, $force);
53 * Checks the state of the given server.
55 * @param string $server_url URL of the given server
56 * @param string $network Network value that is used, when detection failed
57 * @param boolean $force Force an update.
59 * @return boolean 'true' if server seems vital
61 public static function check(string $server_url, string $network = '', bool $force = false)
63 // Unify the server address
64 $server_url = trim($server_url, '/');
65 $server_url = str_replace('/index.php', '', $server_url);
67 if ($server_url == '') {
71 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
72 if (DBA::isResult($gserver)) {
73 if ($gserver['created'] <= DBA::NULL_DATETIME) {
74 $fields = ['created' => DateTimeFormat::utcNow()];
75 $condition = ['nurl' => Strings::normaliseLink($server_url)];
76 DBA::update('gserver', $fields, $condition);
79 $last_contact = $gserver['last_contact'];
80 $last_failure = $gserver['last_failure'];
82 // See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
83 // It can happen that a zero date is in the database, but storing it again is forbidden.
84 if ($last_contact < DBA::NULL_DATETIME) {
85 $last_contact = DBA::NULL_DATETIME;
88 if ($last_failure < DBA::NULL_DATETIME) {
89 $last_failure = DBA::NULL_DATETIME;
92 if (!$force && !PortableContact::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
93 Logger::info('No update needed', ['server' => $server_url]);
94 return ($last_contact >= $last_failure);
96 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
98 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
101 return self::detect($server_url, $network);
105 * Detect server data (type, protocol, version number, ...)
106 * The detected data is then updated or inserted in the gserver table.
108 * @param string $url URL of the given server
109 * @param string $network Network value that is used, when detection failed
111 * @return boolean 'true' if server could be detected
113 public static function detect(string $url, string $network = '')
117 // When a nodeinfo is present, we don't need to dig further
118 $xrd_timeout = Config::get('system', 'xrd_timeout');
119 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
120 if ($curlResult->isTimeout()) {
121 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
125 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
127 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
128 if (empty($nodeinfo)) {
129 $nodeinfo = self::fetchStatistics($url);
132 // If that didn't work out well, we use some protocol specific endpoints
133 // For Friendica and Zot based networks we have to dive deeper to reveal more details
134 if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
135 // Fetch the landing page, possibly it reveals some data
136 if (empty($nodeinfo['network'])) {
137 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
138 if ($curlResult->isSuccess()) {
139 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
140 $serverdata = self::analyseRootBody($curlResult, $serverdata, $url);
143 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
144 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
149 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
150 $serverdata = self::detectMastodonAlikes($url, $serverdata);
153 // All following checks are done for systems that always have got a "host-meta" endpoint.
154 // With this check we don't have to waste time and ressources for dead systems.
155 // Also this hopefully prevents us from receiving abuse messages.
156 if (empty($serverdata['network']) && !self::validHostMeta($url)) {
157 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
161 if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
162 $serverdata = self::detectFriendica($url, $serverdata);
165 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
166 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
167 $serverdata = self::fetchSiteinfo($url, $serverdata);
170 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
171 if (empty($serverdata['network'])) {
172 $serverdata = self::detectHubzilla($url, $serverdata);
175 if (empty($serverdata['network'])) {
176 $serverdata = self::detectNextcloud($url, $serverdata);
179 if (empty($serverdata['network'])) {
180 $serverdata = self::detectGNUSocial($url, $serverdata);
183 $serverdata = $nodeinfo;
186 $serverdata = self::checkPoCo($url, $serverdata);
188 // We can't detect the network type. Possibly it is some system that we don't know yet
189 if (empty($serverdata['network'])) {
190 $serverdata['network'] = Protocol::PHANTOM;
193 // When we hadn't been able to detect the network type, we use the hint from the parameter
194 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
195 $serverdata['network'] = $network;
198 $serverdata['url'] = $url;
199 $serverdata['nurl'] = Strings::normaliseLink($url);
201 // We take the highest number that we do find
202 $registeredUsers = $serverdata['registered-users'] ?? 0;
204 // On an active server there has to be at least a single user
205 if (($serverdata['network'] != Protocol::PHANTOM) && ($registeredUsers == 0)) {
206 $registeredUsers = 1;
209 if ($serverdata['network'] != Protocol::PHANTOM) {
210 $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
211 $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
212 $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
213 $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
215 $serverdata['registered-users'] = $registeredUsers;
216 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
219 $serverdata['last_contact'] = DateTimeFormat::utcNow();
221 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
222 if (!DBA::isResult($gserver)) {
223 $serverdata['created'] = DateTimeFormat::utcNow();
224 $ret = DBA::insert('gserver', $serverdata);
226 // Don't override the network with 'unknown' when there had been a valid entry before
227 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
228 unset($serverdata['network']);
231 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
234 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
235 self::discoverRelay($url);
242 * Fetch relay data from a given server url
244 * @param string $server_url address of the server
245 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
247 private static function discoverRelay(string $server_url)
249 Logger::info('Discover relay data', ['server' => $server_url]);
251 $curlResult = Network::curl($server_url . '/.well-known/x-social-relay');
252 if (!$curlResult->isSuccess()) {
256 $data = json_decode($curlResult->getBody(), true);
257 if (!is_array($data)) {
261 $gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
262 if (!DBA::isResult($gserver)) {
266 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
267 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
268 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
271 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
273 if ($data['scope'] == 'tags') {
276 foreach ($data['tags'] as $tag) {
277 $tag = mb_strtolower($tag);
278 if (strlen($tag) < 100) {
283 foreach ($tags as $tag) {
284 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], true);
288 // Create or update the relay contact
290 if (isset($data['protocols'])) {
291 if (isset($data['protocols']['diaspora'])) {
292 $fields['network'] = Protocol::DIASPORA;
294 if (isset($data['protocols']['diaspora']['receive'])) {
295 $fields['batch'] = $data['protocols']['diaspora']['receive'];
296 } elseif (is_string($data['protocols']['diaspora'])) {
297 $fields['batch'] = $data['protocols']['diaspora'];
301 if (isset($data['protocols']['dfrn'])) {
302 $fields['network'] = Protocol::DFRN;
304 if (isset($data['protocols']['dfrn']['receive'])) {
305 $fields['batch'] = $data['protocols']['dfrn']['receive'];
306 } elseif (is_string($data['protocols']['dfrn'])) {
307 $fields['batch'] = $data['protocols']['dfrn'];
311 Diaspora::setRelayContact($server_url, $fields);
315 * Fetch server data from '/statistics.json' on the given server
317 * @param string $url URL of the given server
319 * @return array server data
321 private static function fetchStatistics(string $url)
323 $curlResult = Network::curl($url . '/statistics.json');
324 if (!$curlResult->isSuccess()) {
328 $data = json_decode($curlResult->getBody(), true);
335 if (!empty($data['version'])) {
336 $serverdata['version'] = $data['version'];
337 // Version numbers on statistics.json are presented with additional info, e.g.:
338 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
339 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
342 if (!empty($data['name'])) {
343 $serverdata['site_name'] = $data['name'];
346 if (!empty($data['network'])) {
347 $serverdata['platform'] = $data['network'];
349 if ($serverdata['platform'] == 'Diaspora') {
350 $serverdata['network'] = Protocol::DIASPORA;
351 } elseif ($serverdata['platform'] == 'Friendica') {
352 $serverdata['network'] = Protocol::DFRN;
353 } elseif ($serverdata['platform'] == 'hubzilla') {
354 $serverdata['network'] = Protocol::ZOT;
355 } elseif ($serverdata['platform'] == 'redmatrix') {
356 $serverdata['network'] = Protocol::ZOT;
361 if (!empty($data['registrations_open'])) {
362 $serverdata['register_policy'] = Register::OPEN;
364 $serverdata['register_policy'] = Register::CLOSED;
371 * Detect server type by using the nodeinfo data
373 * @param string $url address of the server
374 * @return array Server data
375 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
377 private static function fetchNodeinfo(string $url, $curlResult)
379 $nodeinfo = json_decode($curlResult->getBody(), true);
381 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
388 foreach ($nodeinfo['links'] as $link) {
389 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
390 Logger::info('Invalid nodeinfo format', ['url' => $url]);
393 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
394 $nodeinfo1_url = $link['href'];
395 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
396 $nodeinfo2_url = $link['href'];
400 if ($nodeinfo1_url . $nodeinfo2_url == '') {
406 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
407 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
408 $server = self::parseNodeinfo2($nodeinfo2_url);
411 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
412 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
413 $server = self::parseNodeinfo1($nodeinfo1_url);
422 * @param string $nodeinfo_url address of the nodeinfo path
423 * @return array Server data
424 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
426 private static function parseNodeinfo1(string $nodeinfo_url)
428 $curlResult = Network::curl($nodeinfo_url);
430 if (!$curlResult->isSuccess()) {
434 $nodeinfo = json_decode($curlResult->getBody(), true);
436 if (!is_array($nodeinfo)) {
442 $server['register_policy'] = Register::CLOSED;
444 if (!empty($nodeinfo['openRegistrations'])) {
445 $server['register_policy'] = Register::OPEN;
448 if (is_array($nodeinfo['software'])) {
449 if (!empty($nodeinfo['software']['name'])) {
450 $server['platform'] = $nodeinfo['software']['name'];
453 if (!empty($nodeinfo['software']['version'])) {
454 $server['version'] = $nodeinfo['software']['version'];
455 // Version numbers on Nodeinfo are presented with additional info, e.g.:
456 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
457 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
461 if (!empty($nodeinfo['metadata']['nodeName'])) {
462 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
465 if (!empty($nodeinfo['usage']['users']['total'])) {
466 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
469 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
471 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
472 $protocols[$protocol] = true;
475 if (!empty($protocols['friendica'])) {
476 $server['network'] = Protocol::DFRN;
477 } elseif (!empty($protocols['activitypub'])) {
478 $server['network'] = Protocol::ACTIVITYPUB;
479 } elseif (!empty($protocols['diaspora'])) {
480 $server['network'] = Protocol::DIASPORA;
481 } elseif (!empty($protocols['ostatus'])) {
482 $server['network'] = Protocol::OSTATUS;
483 } elseif (!empty($protocols['gnusocial'])) {
484 $server['network'] = Protocol::OSTATUS;
485 } elseif (!empty($protocols['zot'])) {
486 $server['network'] = Protocol::ZOT;
490 if (empty($server)) {
500 * @param string $nodeinfo_url address of the nodeinfo path
501 * @return array Server data
502 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
504 private static function parseNodeinfo2(string $nodeinfo_url)
506 $curlResult = Network::curl($nodeinfo_url);
507 if (!$curlResult->isSuccess()) {
511 $nodeinfo = json_decode($curlResult->getBody(), true);
513 if (!is_array($nodeinfo)) {
519 $server['register_policy'] = Register::CLOSED;
521 if (!empty($nodeinfo['openRegistrations'])) {
522 $server['register_policy'] = Register::OPEN;
525 if (is_array($nodeinfo['software'])) {
526 if (!empty($nodeinfo['software']['name'])) {
527 $server['platform'] = $nodeinfo['software']['name'];
530 if (!empty($nodeinfo['software']['version'])) {
531 $server['version'] = $nodeinfo['software']['version'];
532 // Version numbers on Nodeinfo are presented with additional info, e.g.:
533 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
534 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
538 if (!empty($nodeinfo['metadata']['nodeName'])) {
539 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
542 if (!empty($nodeinfo['usage']['users']['total'])) {
543 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
546 if (!empty($nodeinfo['protocols'])) {
548 foreach ($nodeinfo['protocols'] as $protocol) {
549 $protocols[$protocol] = true;
552 if (!empty($protocols['friendica'])) {
553 $server['network'] = Protocol::DFRN;
554 } elseif (!empty($protocols['activitypub'])) {
555 $server['network'] = Protocol::ACTIVITYPUB;
556 } elseif (!empty($protocols['diaspora'])) {
557 $server['network'] = Protocol::DIASPORA;
558 } elseif (!empty($protocols['ostatus'])) {
559 $server['network'] = Protocol::OSTATUS;
560 } elseif (!empty($protocols['gnusocial'])) {
561 $server['network'] = Protocol::OSTATUS;
562 } elseif (!empty($protocols['zot'])) {
563 $server['network'] = Protocol::ZOT;
567 if (empty($server)) {
575 * Fetch server information from a 'siteinfo.json' file on the given server
577 * @param string $url URL of the given server
578 * @param array $serverdata array with server data
580 * @return array server data
582 private static function fetchSiteinfo(string $url, array $serverdata)
584 $curlResult = Network::curl($url . '/siteinfo.json');
585 if (!$curlResult->isSuccess()) {
589 $data = json_decode($curlResult->getBody(), true);
594 if (!empty($data['url'])) {
595 $serverdata['platform'] = $data['platform'];
596 $serverdata['version'] = $data['version'];
599 if (!empty($data['plugins'])) {
600 if (in_array('pubcrawl', $data['plugins'])) {
601 $serverdata['network'] = Protocol::ACTIVITYPUB;
602 } elseif (in_array('diaspora', $data['plugins'])) {
603 $serverdata['network'] = Protocol::DIASPORA;
604 } elseif (in_array('gnusoc', $data['plugins'])) {
605 $serverdata['network'] = Protocol::OSTATUS;
607 $serverdata['network'] = Protocol::ZOT;
611 if (!empty($data['site_name'])) {
612 $serverdata['site_name'] = $data['site_name'];
615 if (!empty($data['channels_total'])) {
616 $serverdata['registered-users'] = $data['channels_total'];
619 if (!empty($data['register_policy'])) {
620 switch ($data['register_policy']) {
621 case 'REGISTER_OPEN':
622 $serverdata['register_policy'] = Register::OPEN;
625 case 'REGISTER_APPROVE':
626 $serverdata['register_policy'] = Register::APPROVE;
629 case 'REGISTER_CLOSED':
631 $serverdata['register_policy'] = Register::CLOSED;
640 * Checks if the server contains a valid host meta file
642 * @param string $url URL of the given server
644 * @return boolean 'true' if the server seems to be vital
646 private static function validHostMeta(string $url)
648 $xrd_timeout = Config::get('system', 'xrd_timeout');
649 $curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
650 if (!$curlResult->isSuccess()) {
654 $xrd = XML::parseString($curlResult->getBody(), false);
655 if (!is_object($xrd)) {
659 $elements = XML::elementToArray($xrd);
660 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
665 foreach ($elements['xrd']['link'] as $link) {
666 // When there is more than a single "link" element, the array looks slightly different
667 if (!empty($link['@attributes'])) {
668 $link = $link['@attributes'];
671 if (empty($link['rel']) || empty($link['template'])) {
675 if ($link['rel'] == 'lrdd') {
676 // When the webfinger host is the same like the system host, it should be ok.
677 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
685 * Detect the network of the given server via their known contacts
687 * @param string $url URL of the given server
688 * @param array $serverdata array with server data
690 * @return array server data
692 private static function detectNetworkViaContacts(string $url, array $serverdata)
696 $gcontacts = DBA::select('gcontact', ['url', 'nurl'], ['server_url' => [$url, $serverdata['nurl']]]);
697 while ($gcontact = DBA::fetch($gcontacts)) {
698 $contacts[$gcontact['nurl']] = $gcontact['url'];
700 DBA::close($gcontacts);
702 $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
703 while ($gcontact = DBA::fetch($gcontacts)) {
704 $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
706 DBA::close($apcontacts);
708 $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
709 while ($gcontact = DBA::fetch($gcontacts)) {
710 $contacts[$pcontact['nurl']] = $pcontact['url'];
712 DBA::close($pcontacts);
714 if (empty($contacts)) {
718 foreach ($contacts as $contact) {
719 $probed = Probe::uri($contact);
720 if (in_array($probed['network'], Protocol::FEDERATED)) {
721 $serverdata['network'] = $probed['network'];
726 $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
732 * Checks if the given server does have a '/poco' endpoint.
733 * This is used for the 'PortableContact' functionality,
734 * which is used by both Friendica and Hubzilla.
736 * @param string $url URL of the given server
737 * @param array $serverdata array with server data
739 * @return array server data
741 private static function checkPoCo(string $url, array $serverdata)
743 $curlResult = Network::curl($url. '/poco');
744 if (!$curlResult->isSuccess()) {
748 $data = json_decode($curlResult->getBody(), true);
753 if (!empty($data['totalResults'])) {
754 $registeredUsers = $serverdata['registered-users'] ?? 0;
755 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
756 $serverdata['poco'] = $url . '/poco';
758 $serverdata['poco'] = '';
765 * Detects the version number of a given server when it was a NextCloud installation
767 * @param string $url URL of the given server
768 * @param array $serverdata array with server data
770 * @return array server data
772 private static function detectNextcloud(string $url, array $serverdata)
774 $curlResult = Network::curl($url . '/status.php');
776 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
780 $data = json_decode($curlResult->getBody(), true);
785 if (!empty($data['version'])) {
786 $serverdata['platform'] = 'nextcloud';
787 $serverdata['version'] = $data['version'];
788 $serverdata['network'] = Protocol::ACTIVITYPUB;
795 * Detects data from a given server url if it was a mastodon alike system
797 * @param string $url URL of the given server
798 * @param array $serverdata array with server data
800 * @return array server data
802 private static function detectMastodonAlikes(string $url, array $serverdata)
804 $curlResult = Network::curl($url . '/api/v1/instance');
806 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
810 $data = json_decode($curlResult->getBody(), true);
815 if (!empty($data['version'])) {
816 $serverdata['platform'] = 'mastodon';
817 $serverdata['version'] = $data['version'] ?? '';
818 $serverdata['network'] = Protocol::ACTIVITYPUB;
821 if (!empty($data['title'])) {
822 $serverdata['site_name'] = $data['title'];
825 if (!empty($data['description'])) {
826 $serverdata['info'] = trim($data['description']);
829 if (!empty($data['stats']['user_count'])) {
830 $serverdata['registered-users'] = $data['stats']['user_count'];
833 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
834 $serverdata['platform'] = $matches[1];
835 $serverdata['version'] = $matches[2];
838 if (!empty($serverdata['version']) && strstr($serverdata['version'], 'Pleroma')) {
839 $serverdata['platform'] = 'pleroma';
840 $serverdata['version'] = trim(str_replace('Pleroma', '', $serverdata['version']));
847 * Detects data from typical Hubzilla endpoints
849 * @param string $url URL of the given server
850 * @param array $serverdata array with server data
852 * @return array server data
854 private static function detectHubzilla(string $url, array $serverdata)
856 $curlResult = Network::curl($url . '/api/statusnet/config.json');
857 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
861 $data = json_decode($curlResult->getBody(), true);
866 if (!empty($data['site']['name'])) {
867 $serverdata['site_name'] = $data['site']['name'];
870 if (!empty($data['site']['platform'])) {
871 $serverdata['platform'] = $data['site']['platform']['PLATFORM_NAME'];
872 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
873 $serverdata['network'] = Protocol::ZOT;
876 if (!empty($data['site']['hubzilla'])) {
877 $serverdata['platform'] = $data['site']['hubzilla']['PLATFORM_NAME'];
878 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
879 $serverdata['network'] = Protocol::ZOT;
882 if (!empty($data['site']['redmatrix'])) {
883 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
884 $serverdata['platform'] = $data['site']['redmatrix']['PLATFORM_NAME'];
885 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
886 $serverdata['platform'] = $data['site']['redmatrix']['RED_PLATFORM'];
889 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
890 $serverdata['network'] = Protocol::ZOT;
897 if (!empty($data['site']['closed'])) {
898 $closed = self::toBoolean($data['site']['closed']);
901 if (!empty($data['site']['private'])) {
902 $private = self::toBoolean($data['site']['private']);
905 if (!empty($data['site']['inviteonly'])) {
906 $inviteonly = self::toBoolean($data['site']['inviteonly']);
909 if (!$closed && !$private and $inviteonly) {
910 $register_policy = Register::APPROVE;
911 } elseif (!$closed && !$private) {
912 $register_policy = Register::OPEN;
914 $register_policy = Register::CLOSED;
921 * Converts input value to a boolean value
923 * @param string|integer $val
927 private static function toBoolean($val)
929 if (($val == 'true') || ($val == 1)) {
931 } elseif (($val == 'false') || ($val == 0)) {
939 * Detect if the URL belongs to a GNU Social server
941 * @param string $url URL of the given server
942 * @param array $serverdata array with server data
944 * @return array server data
946 private static function detectGNUSocial(string $url, array $serverdata)
948 // Test for GNU Social
949 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
950 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
951 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
952 $serverdata['platform'] = 'gnusocial';
953 // Remove junk that some GNU Social servers return
954 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
955 $serverdata['version'] = trim($serverdata['version'], '"');
956 $serverdata['network'] = Protocol::OSTATUS;
960 // Test for Statusnet
961 $curlResult = Network::curl($url . '/api/statusnet/version.json');
962 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
963 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
964 $serverdata['platform'] = 'statusnet';
965 // Remove junk that some GNU Social servers return
966 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
967 $serverdata['version'] = trim($serverdata['version'], '"');
968 $serverdata['network'] = Protocol::OSTATUS;
975 * Detect if the URL belongs to a Friendica server
977 * @param string $url URL of the given server
978 * @param array $serverdata array with server data
980 * @return array server data
982 private static function detectFriendica(string $url, array $serverdata)
984 $curlResult = Network::curl($url . '/friendica/json');
985 if (!$curlResult->isSuccess()) {
986 $curlResult = Network::curl($url . '/friendika/json');
989 if (!$curlResult->isSuccess()) {
993 $data = json_decode($curlResult->getBody(), true);
994 if (empty($data) || empty($data['version'])) {
998 $serverdata['network'] = Protocol::DFRN;
999 $serverdata['version'] = $data['version'];
1001 if (!empty($data['no_scrape_url'])) {
1002 $serverdata['noscrape'] = $data['no_scrape_url'];
1005 if (!empty($data['site_name'])) {
1006 $serverdata['site_name'] = $data['site_name'];
1009 if (!empty($data['info'])) {
1010 $serverdata['info'] = trim($data['info']);
1013 $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
1014 switch ($register_policy) {
1015 case 'REGISTER_OPEN':
1016 $serverdata['register_policy'] = Register::OPEN;
1019 case 'REGISTER_APPROVE':
1020 $serverdata['register_policy'] = Register::APPROVE;
1023 case 'REGISTER_CLOSED':
1024 case 'REGISTER_INVITATION':
1025 $serverdata['register_policy'] = Register::CLOSED;
1028 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
1029 $serverdata['register_policy'] = Register::CLOSED;
1033 $serverdata['platform'] = $data['platform'] ?? '';
1039 * Analyses the landing page of a given server for hints about type and system of that server
1041 * @param object $curlResult result of curl execution
1042 * @param array $serverdata array with server data
1043 * @param string $url Server URL
1045 * @return array server data
1047 private static function analyseRootBody($curlResult, array $serverdata, string $url)
1049 $doc = new DOMDocument();
1050 @$doc->loadHTML($curlResult->getBody());
1051 $xpath = new DOMXPath($doc);
1053 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1054 if (!empty($title)) {
1055 $serverdata['site_name'] = $title;
1058 $list = $xpath->query('//meta[@name]');
1060 foreach ($list as $node) {
1062 if ($node->attributes->length) {
1063 foreach ($node->attributes as $attribute) {
1064 $value = trim($attribute->value);
1065 if (empty($value)) {
1069 $attr[$attribute->name] = $value;
1072 if (empty($attr['name']) || empty($attr['content'])) {
1077 if ($attr['name'] == 'description') {
1078 $serverdata['info'] = $attr['content'];
1081 if ($attr['name'] == 'application-name') {
1082 $serverdata['platform'] = $attr['content'];
1083 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1084 $serverdata['network'] = Protocol::ACTIVITYPUB;
1088 if ($attr['name'] == 'generator') {
1089 $serverdata['platform'] = $attr['content'];
1091 $version_part = explode(' ', $attr['content']);
1093 if (count($version_part) == 2) {
1094 if (in_array($version_part[0], ['WordPress'])) {
1095 $serverdata['platform'] = $version_part[0];
1096 $serverdata['version'] = $version_part[1];
1098 // We still do need a reliable test if some AP plugin is activated
1099 if (DBA::exists('apcontact', ['baseurl' => $url])) {
1100 $serverdata['network'] = Protocol::ACTIVITYPUB;
1102 $serverdata['network'] = Protocol::FEED;
1105 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1106 $serverdata['platform'] = $version_part[0];
1107 $serverdata['version'] = $version_part[1];
1108 $serverdata['network'] = Protocol::DFRN;
1114 $list = $xpath->query('//meta[@property]');
1116 foreach ($list as $node) {
1118 if ($node->attributes->length) {
1119 foreach ($node->attributes as $attribute) {
1120 $value = trim($attribute->value);
1121 if (empty($value)) {
1125 $attr[$attribute->name] = $value;
1128 if (empty($attr['property']) || empty($attr['content'])) {
1133 if ($attr['property'] == 'og:site_name') {
1134 $serverdata['site_name'] = $attr['content'];
1137 if ($attr['property'] == 'og:description') {
1138 $serverdata['info'] = $attr['content'];
1141 if ($attr['property'] == 'og:platform') {
1142 $serverdata['platform'] = $attr['content'];
1144 if (in_array($attr['content'], ['PeerTube'])) {
1145 $serverdata['network'] = Protocol::ACTIVITYPUB;
1149 if ($attr['property'] == 'generator') {
1150 $serverdata['platform'] = $attr['content'];
1152 if (in_array($attr['content'], ['hubzilla'])) {
1153 // We later check which compatible protocol modules are loaded.
1154 $serverdata['network'] = Protocol::ZOT;
1163 * Analyses the header data of a given server for hints about type and system of that server
1165 * @param object $curlResult result of curl execution
1166 * @param array $serverdata array with server data
1168 * @return array server data
1170 private static function analyseRootHeader($curlResult, array $serverdata)
1172 if ($curlResult->getHeader('server') == 'Mastodon') {
1173 $serverdata['platform'] = 'mastodon';
1174 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
1175 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1176 $serverdata['platform'] = 'diaspora';
1177 $serverdata['network'] = $network = Protocol::DIASPORA;
1178 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
1180 } elseif ($curlResult->inHeader('x-friendica-version')) {
1181 $serverdata['platform'] = 'friendica';
1182 $serverdata['network'] = $network = Protocol::DFRN;
1183 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');