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 the state of the given server.
32 * @param string $server_url URL of the given server
33 * @param string $network Network value that is used, when detection failed
34 * @param boolean $force Force an update.
36 * @return boolean "true" if server seems vital
38 public static function check(string $server_url, string $network = '', bool $force = false)
40 // Unify the server address
41 $server_url = trim($server_url, '/');
42 $server_url = str_replace('/index.php', '', $server_url);
44 if ($server_url == '') {
48 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
49 if (DBA::isResult($gserver)) {
50 if ($gserver['created'] <= DBA::NULL_DATETIME) {
51 $fields = ['created' => DateTimeFormat::utcNow()];
52 $condition = ['nurl' => Strings::normaliseLink($server_url)];
53 DBA::update('gserver', $fields, $condition);
56 $last_contact = $gserver["last_contact"];
57 $last_failure = $gserver["last_failure"];
59 // See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
60 // It can happen that a zero date is in the database, but storing it again is forbidden.
61 if ($last_contact < DBA::NULL_DATETIME) {
62 $last_contact = DBA::NULL_DATETIME;
65 if ($last_failure < DBA::NULL_DATETIME) {
66 $last_failure = DBA::NULL_DATETIME;
69 if (!$force && !PortableContact::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
70 Logger::info('No update needed', ['server' => $server_url]);
71 return ($last_contact >= $last_failure);
73 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
75 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
78 return self::detect($server_url, $network);
82 * Detect server data (type, protocol, version number, ...)
83 * The detected data is then updated or inserted in the gserver table.
85 * @param string $url URL of the given server
86 * @param string $network Network value that is used, when detection failed
88 * @return boolean 'true' if server could be detected
90 public static function detect(string $url, string $network = '')
94 // When a nodeinfo is present, we don't need to dig further
95 $xrd_timeout = Config::get('system', 'xrd_timeout');
96 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
97 if ($curlResult->isTimeout()) {
98 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
102 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
104 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
105 if (empty($nodeinfo)) {
106 $nodeinfo = self::fetchStatistics($url);
109 // If that didn't work out well, we use some protocol specific endpoints
110 if (empty($nodeinfo) || empty($nodeinfo['network']) || ($nodeinfo['network'] == Protocol::DFRN)) {
111 // Fetch the landing page, possibly it reveals some data
112 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
113 if ($curlResult->isSuccess()) {
114 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
115 $serverdata = self::analyseRootBody($curlResult, $serverdata);
118 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
119 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
123 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::DFRN)) {
124 $serverdata = self::detectFriendica($url, $serverdata);
127 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
128 $serverdata = self::detectMastodonAlikes($url, $serverdata);
131 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
132 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
133 $serverdata = self::fetchSiteinfo($url, $serverdata);
136 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
137 if (empty($serverdata['network'])) {
138 $serverdata = self::detectHubzilla($url, $serverdata);
141 if (empty($serverdata['network'])) {
142 $serverdata = self::detectNextcloud($url, $serverdata);
145 if (empty($serverdata['network'])) {
146 $serverdata = self::detectGNUSocial($url, $serverdata);
149 $serverdata = $nodeinfo;
152 $serverdata = self::checkPoCo($url, $serverdata);
154 // We can't detect the network type. Possibly it is some system that we don't know yet
155 if (empty($serverdata['network'])) {
156 $serverdata['network'] = Protocol::PHANTOM;
159 // When we hadn't been able to detect the network type, we use the hint from the parameter
160 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
161 $serverdata['network'] = $network;
164 // Check host-meta for phantom networks.
165 // Although this is not needed, it is a good indicator for a living system,
166 // since most systems had implemented it.
167 if (($serverdata['network'] == Protocol::PHANTOM) && !self::validHostMeta($url)) {
168 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
172 $serverdata['url'] = $url;
173 $serverdata['nurl'] = Strings::normaliseLink($url);
175 // We take the highest number that we do find
176 $registeredUsers = $serverdata['registered-users'] ?? 0;
178 // On an active server there has to be at least a single user
179 if (($serverdata['network'] != Protocol::PHANTOM) && ($registeredUsers == 0)) {
180 $registeredUsers = 1;
183 if ($serverdata['network'] != Protocol::PHANTOM) {
184 $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
185 $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
186 $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
187 $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
189 $serverdata['registered-users'] = $registeredUsers;
190 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
193 $serverdata['last_contact'] = DateTimeFormat::utcNow();
195 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
196 if (!DBA::isResult($gserver)) {
197 $serverdata['created'] = DateTimeFormat::utcNow();
198 $ret = DBA::insert('gserver', $serverdata);
200 // Don't override the network with "unknown" when there had been a valid entry before
201 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
202 unset($serverdata['network']);
205 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
208 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
209 self::discoverRelay($url);
216 * Fetch relay data from a given server url
218 * @param string $server_url address of the server
219 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
221 private static function discoverRelay(string $server_url)
223 Logger::info('Discover relay data', ['server' => $server_url]);
225 $curlResult = Network::curl($server_url . '/.well-known/x-social-relay');
226 if (!$curlResult->isSuccess()) {
230 $data = json_decode($curlResult->getBody(), true);
231 if (!is_array($data)) {
235 $gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
236 if (!DBA::isResult($gserver)) {
240 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
241 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
242 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
245 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
247 if ($data['scope'] == 'tags') {
250 foreach ($data['tags'] as $tag) {
251 $tag = mb_strtolower($tag);
252 if (strlen($tag) < 100) {
257 foreach ($tags as $tag) {
258 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], true);
262 // Create or update the relay contact
264 if (isset($data['protocols'])) {
265 if (isset($data['protocols']['diaspora'])) {
266 $fields['network'] = Protocol::DIASPORA;
268 if (isset($data['protocols']['diaspora']['receive'])) {
269 $fields['batch'] = $data['protocols']['diaspora']['receive'];
270 } elseif (is_string($data['protocols']['diaspora'])) {
271 $fields['batch'] = $data['protocols']['diaspora'];
275 if (isset($data['protocols']['dfrn'])) {
276 $fields['network'] = Protocol::DFRN;
278 if (isset($data['protocols']['dfrn']['receive'])) {
279 $fields['batch'] = $data['protocols']['dfrn']['receive'];
280 } elseif (is_string($data['protocols']['dfrn'])) {
281 $fields['batch'] = $data['protocols']['dfrn'];
285 Diaspora::setRelayContact($server_url, $fields);
289 * Fetch server data from '/statistics.json' on the given server
291 * @param string $url URL of the given server
293 * @return array server data
295 private static function fetchStatistics(string $url)
297 $curlResult = Network::curl($url . '/statistics.json');
298 if (!$curlResult->isSuccess()) {
302 $data = json_decode($curlResult->getBody(), true);
309 if (!empty($data['version'])) {
310 $serverdata['version'] = $data['version'];
311 // Version numbers on statistics.json are presented with additional info, e.g.:
312 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
313 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
316 if (!empty($data['name'])) {
317 $serverdata['site_name'] = $data['name'];
320 if (!empty($data['network'])) {
321 $serverdata['platform'] = $data['network'];
323 if ($serverdata['platform'] == 'Diaspora') {
324 $serverdata['network'] = Protocol::DIASPORA;
325 } elseif ($serverdata['platform'] == 'Friendica') {
326 $serverdata['network'] = Protocol::DFRN;
327 } elseif ($serverdata['platform'] == 'hubzilla') {
328 $serverdata['network'] = Protocol::ZOT;
329 } elseif ($serverdata['platform'] == 'redmatrix') {
330 $serverdata['network'] = Protocol::ZOT;
335 if (!empty($data['registrations_open'])) {
336 $serverdata['register_policy'] = Register::OPEN;
338 $serverdata['register_policy'] = Register::CLOSED;
345 * Detect server type by using the nodeinfo data
347 * @param string $url address of the server
348 * @return array Server data
349 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
351 private static function fetchNodeinfo(string $url, $curlResult)
353 $nodeinfo = json_decode($curlResult->getBody(), true);
355 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
362 foreach ($nodeinfo['links'] as $link) {
363 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
364 Logger::info('Invalid nodeinfo format', ['url' => $url]);
367 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
368 $nodeinfo1_url = $link['href'];
369 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
370 $nodeinfo2_url = $link['href'];
374 if ($nodeinfo1_url . $nodeinfo2_url == '') {
380 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
381 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
382 $server = self::parseNodeinfo2($nodeinfo2_url);
385 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
386 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
387 $server = self::parseNodeinfo1($nodeinfo1_url);
396 * @param string $nodeinfo_url address of the nodeinfo path
397 * @return array Server data
398 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
400 private static function parseNodeinfo1(string $nodeinfo_url)
402 $curlResult = Network::curl($nodeinfo_url);
404 if (!$curlResult->isSuccess()) {
408 $nodeinfo = json_decode($curlResult->getBody(), true);
410 if (!is_array($nodeinfo)) {
416 $server['register_policy'] = Register::CLOSED;
418 if (!empty($nodeinfo['openRegistrations'])) {
419 $server['register_policy'] = Register::OPEN;
422 if (is_array($nodeinfo['software'])) {
423 if (!empty($nodeinfo['software']['name'])) {
424 $server['platform'] = $nodeinfo['software']['name'];
427 if (!empty($nodeinfo['software']['version'])) {
428 $server['version'] = $nodeinfo['software']['version'];
429 // Version numbers on Nodeinfo are presented with additional info, e.g.:
430 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
431 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
435 if (!empty($nodeinfo['metadata']['nodeName'])) {
436 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
439 if (!empty($nodeinfo['usage']['users']['total'])) {
440 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
443 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
445 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
446 $protocols[$protocol] = true;
449 if (!empty($protocols['friendica'])) {
450 $server['network'] = Protocol::DFRN;
451 } elseif (!empty($protocols['activitypub'])) {
452 $server['network'] = Protocol::ACTIVITYPUB;
453 } elseif (!empty($protocols['diaspora'])) {
454 $server['network'] = Protocol::DIASPORA;
455 } elseif (!empty($protocols['ostatus'])) {
456 $server['network'] = Protocol::OSTATUS;
457 } elseif (!empty($protocols['gnusocial'])) {
458 $server['network'] = Protocol::OSTATUS;
459 } elseif (!empty($protocols['zot'])) {
460 $server['network'] = Protocol::ZOT;
474 * @param string $nodeinfo_url address of the nodeinfo path
475 * @return array Server data
476 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
478 private static function parseNodeinfo2(string $nodeinfo_url)
480 $curlResult = Network::curl($nodeinfo_url);
481 if (!$curlResult->isSuccess()) {
485 $nodeinfo = json_decode($curlResult->getBody(), true);
487 if (!is_array($nodeinfo)) {
493 $server['register_policy'] = Register::CLOSED;
495 if (!empty($nodeinfo['openRegistrations'])) {
496 $server['register_policy'] = Register::OPEN;
499 if (is_array($nodeinfo['software'])) {
500 if (!empty($nodeinfo['software']['name'])) {
501 $server['platform'] = $nodeinfo['software']['name'];
504 if (!empty($nodeinfo['software']['version'])) {
505 $server['version'] = $nodeinfo['software']['version'];
506 // Version numbers on Nodeinfo are presented with additional info, e.g.:
507 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
508 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
512 if (!empty($nodeinfo['metadata']['nodeName'])) {
513 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
516 if (!empty($nodeinfo['usage']['users']['total'])) {
517 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
520 if (!empty($nodeinfo['protocols'])) {
522 foreach ($nodeinfo['protocols'] as $protocol) {
523 $protocols[$protocol] = true;
526 if (!empty($protocols['friendica'])) {
527 $server['network'] = Protocol::DFRN;
528 } elseif (!empty($protocols['activitypub'])) {
529 $server['network'] = Protocol::ACTIVITYPUB;
530 } elseif (!empty($protocols['diaspora'])) {
531 $server['network'] = Protocol::DIASPORA;
532 } elseif (!empty($protocols['ostatus'])) {
533 $server['network'] = Protocol::OSTATUS;
534 } elseif (!empty($protocols['gnusocial'])) {
535 $server['network'] = Protocol::OSTATUS;
536 } elseif (!empty($protocols['zot'])) {
537 $server['network'] = Protocol::ZOT;
541 if (empty($server)) {
549 * Fetch server information from a "siteinfo.json" file on the given server
551 * @param string $url URL of the given server
552 * @param array $serverdata array with server data
554 * @return array server data
556 private static function fetchSiteinfo(string $url, array $serverdata)
558 $curlResult = Network::curl($url . '/siteinfo.json');
559 if (!$curlResult->isSuccess()) {
563 $data = json_decode($curlResult->getBody(), true);
568 if (!empty($data['url'])) {
569 $serverdata['platform'] = $data['platform'];
570 $serverdata['version'] = $data['version'];
573 if (!empty($data['plugins'])) {
574 if (in_array('pubcrawl', $data['plugins'])) {
575 $serverdata['network'] = Protocol::ACTIVITYPUB;
576 } elseif (in_array('diaspora', $data['plugins'])) {
577 $serverdata['network'] = Protocol::DIASPORA;
578 } elseif (in_array('gnusoc', $data['plugins'])) {
579 $serverdata['network'] = Protocol::OSTATUS;
581 $serverdata['network'] = Protocol::ZOT;
585 if (!empty($data['site_name'])) {
586 $serverdata['site_name'] = $data['site_name'];
589 if (!empty($data['channels_total'])) {
590 $serverdata['registered-users'] = $data['channels_total'];
593 if (!empty($data['register_policy'])) {
594 switch ($data['register_policy']) {
595 case 'REGISTER_OPEN':
596 $serverdata['register_policy'] = Register::OPEN;
599 case 'REGISTER_APPROVE':
600 $serverdata['register_policy'] = Register::APPROVE;
603 case 'REGISTER_CLOSED':
605 $serverdata['register_policy'] = Register::CLOSED;
614 * Checks if the server contains a valid host meta file
616 * @param string $url URL of the given server
618 * @return boolean "true" if the server seems to be vital
620 private static function validHostMeta(string $url)
622 $xrd_timeout = Config::get('system', 'xrd_timeout');
623 $curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
624 if (!$curlResult->isSuccess()) {
628 $xrd = XML::parseString($curlResult->getBody(), false);
629 if (!is_object($xrd)) {
633 $elements = XML::elementToArray($xrd);
634 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
639 foreach ($elements['xrd']['link'] as $link) {
640 if (empty($link['rel']) || empty($link['type']) || empty($link['template'])) {
644 if ($link['type'] == 'application/xrd+xml') {
645 // When the webfinger host is the same like the system host, it should be ok.
646 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
654 * Detect the network of the given server via their known contacts
656 * @param string $url URL of the given server
657 * @param array $serverdata array with server data
659 * @return array server data
661 private static function detectNetworkViaContacts(string $url, array $serverdata)
664 $fields = ['nurl', 'url'];
666 $gcontacts = DBA::select('gcontact', $fields, ['server_url' => [$url, $serverdata['nurl']]]);
667 while ($gcontact = DBA::fetch($gcontacts)) {
668 $contacts[$gcontact['nurl']] = $gcontact['url'];
670 DBA::close($gcontacts);
672 $apcontacts = DBA::select('apcontact', $fields, ['baseurl' => [$url, $serverdata['nurl']]]);
673 while ($gcontact = DBA::fetch($gcontacts)) {
674 $contacts[$apcontact['nurl']] = $apcontact['url'];
676 DBA::close($apcontacts);
678 $pcontacts = DBA::select('contact', $fields, ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
679 while ($gcontact = DBA::fetch($gcontacts)) {
680 $contacts[$pcontact['nurl']] = $pcontact['url'];
682 DBA::close($pcontacts);
684 if (empty($contacts)) {
688 foreach ($contacts as $contact) {
689 $probed = Probe::uri($contact);
690 if (in_array($probed['network'], Protocol::FEDERATED)) {
691 $serverdata['network'] = $probed['network'];
696 $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
702 * Checks if the given server does have a "poco" endpoint
704 * @param string $url URL of the given server
705 * @param array $serverdata array with server data
707 * @return array server data
709 private static function checkPoCo(string $url, array $serverdata)
711 $curlResult = Network::curl($url. '/poco');
712 if (!$curlResult->isSuccess()) {
716 $data = json_decode($curlResult->getBody(), true);
721 if (!empty($data['totalResults'])) {
722 $registeredUsers = $serverdata['registered-users'] ?? 0;
723 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
724 $serverdata['poco'] = $url . '/poco';
726 $serverdata['poco'] = '';
733 * Detects the version number of a given server when it was a NextCloud installation
735 * @param string $url URL of the given server
736 * @param array $serverdata array with server data
738 * @return array server data
740 private static function detectNextcloud(string $url, array $serverdata)
742 $curlResult = Network::curl($url . '/status.php');
744 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
748 $data = json_decode($curlResult->getBody(), true);
753 if (!empty($data['version'])) {
754 $serverdata['platform'] = 'nextcloud';
755 $serverdata['version'] = $data['version'];
756 $serverdata['network'] = Protocol::ACTIVITYPUB;
763 * Detects data from a given server url if it was a mastodon alike system
765 * @param string $url URL of the given server
766 * @param array $serverdata array with server data
768 * @return array server data
770 private static function detectMastodonAlikes(string $url, array $serverdata)
772 $curlResult = Network::curl($url . '/api/v1/instance');
774 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
778 $data = json_decode($curlResult->getBody(), true);
783 if (!empty($data['version'])) {
784 $serverdata['platform'] = 'mastodon';
785 $serverdata['version'] = defaults($data, 'version', '');
786 $serverdata['network'] = Protocol::ACTIVITYPUB;
789 if (!empty($data['title'])) {
790 $serverdata['site_name'] = $data['title'];
793 if (!empty($data['description'])) {
794 $serverdata['info'] = trim($data['description']);
797 if (!empty($data['stats']['user_count'])) {
798 $serverdata['registered-users'] = $data['stats']['user_count'];
801 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
802 $serverdata['platform'] = $matches[1];
803 $serverdata['version'] = $matches[2];
806 if (!empty($serverdata['version']) && strstr($serverdata['version'], 'Pleroma')) {
807 $serverdata['platform'] = 'pleroma';
808 $serverdata['version'] = trim(str_replace('Pleroma', '', $serverdata['version']));
815 * Detects data from typical Hubzilla endpoints
817 * @param string $url URL of the given server
818 * @param array $serverdata array with server data
820 * @return array server data
822 private static function detectHubzilla(string $url, array $serverdata)
824 $curlResult = Network::curl($url . '/api/statusnet/config.json');
825 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
829 $data = json_decode($curlResult->getBody(), true);
834 if (!empty($data['site']['name'])) {
835 $serverdata['site_name'] = $data['site']['name'];
838 if (!empty($data['site']['platform'])) {
839 $serverdata['platform'] = $data['site']['platform']['PLATFORM_NAME'];
840 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
841 $serverdata['network'] = Protocol::ZOT;
844 if (!empty($data['site']['hubzilla'])) {
845 $serverdata['platform'] = $data['site']['hubzilla']['PLATFORM_NAME'];
846 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
847 $serverdata['network'] = Protocol::ZOT;
850 if (!empty($data['site']['redmatrix'])) {
851 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
852 $serverdata['platform'] = $data['site']['redmatrix']['PLATFORM_NAME'];
853 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
854 $serverdata['platform'] = $data['site']['redmatrix']['RED_PLATFORM'];
857 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
858 $serverdata['network'] = Protocol::ZOT;
865 if (!empty($data['site']['closed'])) {
866 $closed = self::toBoolean($data['site']['closed']);
869 if (!empty($data['site']['private'])) {
870 $private = self::toBoolean($data['site']['private']);
873 if (!empty($data['site']['inviteonly'])) {
874 $inviteonly = self::toBoolean($data['site']['inviteonly']);
877 if (!$closed && !$private and $inviteonly) {
878 $register_policy = Register::APPROVE;
879 } elseif (!$closed && !$private) {
880 $register_policy = Register::OPEN;
882 $register_policy = Register::CLOSED;
889 * Converts input value to a boolean value
891 * @param string|integer $val
895 private static function toBoolean($val)
897 if (($val == 'true') || ($val == 1)) {
899 } elseif (($val == 'false') || ($val == 0)) {
907 * Detect if the URL belongs to a GNU Social server
909 * @param string $url URL of the given server
910 * @param array $serverdata array with server data
912 * @return array server data
914 private static function detectGNUSocial(string $url, array $serverdata)
916 $curlResult = Network::curl($url . '/api/statusnet/version.json');
918 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
919 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
920 $serverdata['platform'] = 'StatusNet';
921 // Remove junk that some GNU Social servers return
922 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
923 $serverdata['version'] = trim($serverdata['version'], '"');
924 $serverdata['network'] = Protocol::OSTATUS;
927 // Test for GNU Social
928 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
930 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
931 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
932 $serverdata['platform'] = 'GNU Social';
933 // Remove junk that some GNU Social servers return
934 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
935 $serverdata['version'] = trim($serverdata['version'], '"');
936 $serverdata['network'] = Protocol::OSTATUS;
943 * Detect if the URL belongs to a Friendica server
945 * @param string $url URL of the given server
946 * @param array $serverdata array with server data
948 * @return array server data
950 private static function detectFriendica(string $url, array $serverdata)
952 $curlResult = Network::curl($url . '/friendica/json');
953 if (!$curlResult->isSuccess()) {
954 $curlResult = Network::curl($url . '/friendika/json');
957 if (!$curlResult->isSuccess()) {
961 $data = json_decode($curlResult->getBody(), true);
962 if (empty($data) || empty($data['version'])) {
966 $serverdata['network'] = Protocol::DFRN;
967 $serverdata['version'] = $data['version'];
969 if (!empty($data['no_scrape_url'])) {
970 $serverdata['noscrape'] = $data['no_scrape_url'];
973 if (!empty($data['site_name'])) {
974 $serverdata['site_name'] = $data['site_name'];
977 if (!empty($data['info'])) {
978 $serverdata['info'] = trim($data['info']);
981 $register_policy = defaults($data, 'register_policy', 'REGISTER_CLOSED');
982 switch ($register_policy) {
983 case 'REGISTER_OPEN':
984 $serverdata['register_policy'] = Register::OPEN;
987 case 'REGISTER_APPROVE':
988 $serverdata['register_policy'] = Register::APPROVE;
991 case 'REGISTER_CLOSED':
992 case 'REGISTER_INVITATION':
993 $serverdata['register_policy'] = Register::CLOSED;
996 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
997 $serverdata['register_policy'] = Register::CLOSED;
1001 $serverdata['platform'] = defaults($data, 'platform', '');
1007 * Analyses the landing page of a given server for hints about type and system of that server
1009 * @param object $curlResult result of curl execution
1010 * @param array $serverdata array with server data
1012 * @return array server data
1014 private static function analyseRootBody($curlResult, array $serverdata)
1016 $doc = new DOMDocument();
1017 @$doc->loadHTML($curlResult->getBody());
1018 $xpath = new DOMXPath($doc);
1020 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1021 if (!empty($title)) {
1022 $serverdata['site_name'] = $title;
1025 $list = $xpath->query('//meta[@name]');
1027 foreach ($list as $node) {
1029 if ($node->attributes->length) {
1030 foreach ($node->attributes as $attribute) {
1031 $attribute->value = trim($attribute->value);
1032 if (empty($attribute->value)) {
1036 $attr[$attribute->name] = $attribute->value;
1039 if (empty($attr['name']) || empty($attr['content'])) {
1044 if ($attr['name'] == 'description') {
1045 $serverdata['info'] = $attr['content'];
1048 if ($attr['name'] == 'application-name') {
1049 $serverdata['platform'] = $attr['content'];
1050 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1051 $serverdata['network'] = Protocol::ACTIVITYPUB;
1055 if ($attr['name'] == 'generator') {
1056 $serverdata['platform'] = $attr['content'];
1058 $version_part = explode(' ', $attr['content']);
1060 if (count($version_part) == 2) {
1061 if (in_array($version_part[0], ['WordPress'])) {
1062 $serverdata['platform'] = $version_part[0];
1063 $serverdata['version'] = $version_part[1];
1064 $serverdata['network'] = Protocol::ACTIVITYPUB;
1066 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1067 $serverdata['platform'] = $version_part[0];
1068 $serverdata['version'] = $version_part[1];
1069 $serverdata['network'] = Protocol::DFRN;
1075 $list = $xpath->query('//meta[@property]');
1077 foreach ($list as $node) {
1079 if ($node->attributes->length) {
1080 foreach ($node->attributes as $attribute) {
1081 $attribute->value = trim($attribute->value);
1082 if (empty($attribute->value)) {
1086 $attr[$attribute->name] = $attribute->value;
1089 if (empty($attr['property']) || empty($attr['content'])) {
1094 if ($attr['property'] == 'og:site_name') {
1095 $serverdata['site_name'] = $attr['content'];
1098 if ($attr['property'] == 'og:description') {
1099 $serverdata['info'] = $attr['content'];
1102 if ($attr['property'] == 'og:platform') {
1103 $serverdata['platform'] = $attr['content'];
1105 if (in_array($attr['content'], ['PeerTube'])) {
1106 $serverdata['network'] = Protocol::ACTIVITYPUB;
1110 if ($attr['property'] == 'generator') {
1111 $serverdata['platform'] = $attr['content'];
1113 if (in_array($attr['content'], ['hubzilla'])) {
1114 // We later check which compatible protocol modules are loaded.
1115 $serverdata['network'] = Protocol::ZOT;
1124 * Analyses the header data of a given server for hints about type and system of that server
1126 * @param object $curlResult result of curl execution
1127 * @param array $serverdata array with server data
1129 * @return array server data
1131 private static function analyseRootHeader($curlResult, array $serverdata)
1133 if ($curlResult->getHeader('server') == 'Mastodon') {
1134 $serverdata['platform'] = 'mastodon';
1135 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
1136 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1137 $serverdata['platform'] = 'diaspora';
1138 $serverdata['network'] = $network = Protocol::DIASPORA;
1139 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
1141 } elseif ($curlResult->inHeader('x-friendica-version')) {
1142 $serverdata['platform'] = 'friendica';
1143 $serverdata['network'] = $network = Protocol::DFRN;
1144 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');