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\Core\Worker;
14 use Friendica\Database\DBA;
16 use Friendica\Module\Register;
17 use Friendica\Network\CurlResult;
18 use Friendica\Util\Network;
19 use Friendica\Util\DateTimeFormat;
20 use Friendica\Util\Strings;
21 use Friendica\Util\XML;
22 use Friendica\Core\Logger;
23 use Friendica\Protocol\PortableContact;
24 use Friendica\Protocol\Diaspora;
25 use Friendica\Network\Probe;
28 * This class handles GServer related functions
35 const DT_MASTODON = 2;
37 * Checks if the given server is reachable
39 * @param string $profile URL of the given profile
40 * @param string $server URL of the given server (If empty, taken from profile)
41 * @param string $network Network value that is used, when detection failed
42 * @param boolean $force Force an update.
44 * @return boolean 'true' if server seems vital
46 public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false)
49 $server = GContact::getBasepath($profile);
56 return self::check($server, $network, $force);
60 * Decides if a server needs to be updated, based upon several date fields
62 * @param date $created Creation date of that server entry
63 * @param date $updated When had the server entry be updated
64 * @param date $last_failure Last failure when contacting that server
65 * @param date $last_contact Last time the server had been contacted
67 * @return boolean Does the server record needs an update?
69 public static function updateNeeded($created, $updated, $last_failure, $last_contact)
71 $now = strtotime(DateTimeFormat::utcNow());
73 if ($updated > $last_contact) {
74 $contact_time = strtotime($updated);
76 $contact_time = strtotime($last_contact);
79 $failure_time = strtotime($last_failure);
80 $created_time = strtotime($created);
82 // If there is no "created" time then use the current time
83 if ($created_time <= 0) {
87 // If the last contact was less than 24 hours then don't update
88 if (($now - $contact_time) < (60 * 60 * 24)) {
92 // If the last failure was less than 24 hours then don't update
93 if (($now - $failure_time) < (60 * 60 * 24)) {
97 // If the last contact was less than a week ago and the last failure is older than a week then don't update
98 //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
101 // 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
102 if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
106 // 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
107 if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
115 * Checks the state of the given server.
117 * @param string $server_url URL of the given server
118 * @param string $network Network value that is used, when detection failed
119 * @param boolean $force Force an update.
121 * @return boolean 'true' if server seems vital
123 public static function check(string $server_url, string $network = '', bool $force = false)
125 // Unify the server address
126 $server_url = trim($server_url, '/');
127 $server_url = str_replace('/index.php', '', $server_url);
129 if ($server_url == '') {
133 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
134 if (DBA::isResult($gserver)) {
135 if ($gserver['created'] <= DBA::NULL_DATETIME) {
136 $fields = ['created' => DateTimeFormat::utcNow()];
137 $condition = ['nurl' => Strings::normaliseLink($server_url)];
138 DBA::update('gserver', $fields, $condition);
141 $last_contact = $gserver['last_contact'];
142 $last_failure = $gserver['last_failure'];
144 // See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
145 // It can happen that a zero date is in the database, but storing it again is forbidden.
146 if ($last_contact < DBA::NULL_DATETIME) {
147 $last_contact = DBA::NULL_DATETIME;
150 if ($last_failure < DBA::NULL_DATETIME) {
151 $last_failure = DBA::NULL_DATETIME;
154 if (!$force && !self::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
155 Logger::info('No update needed', ['server' => $server_url]);
156 return ($last_contact >= $last_failure);
158 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
160 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
163 return self::detect($server_url, $network);
167 * Detect server data (type, protocol, version number, ...)
168 * The detected data is then updated or inserted in the gserver table.
170 * @param string $url URL of the given server
171 * @param string $network Network value that is used, when detection failed
173 * @return boolean 'true' if server could be detected
175 public static function detect(string $url, string $network = '')
177 Logger::info('Detect server type', ['server' => $url]);
180 $original_url = $url;
182 // Remove URL content that is not supposed to exist for a server url
183 $urlparts = parse_url($url);
184 unset($urlparts['user']);
185 unset($urlparts['pass']);
186 unset($urlparts['query']);
187 unset($urlparts['fragment']);
188 $url = Network::unparseURL($urlparts);
190 // If the URL missmatches, then we mark the old entry as failure
191 if ($url != $original_url) {
192 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($original_url)]);
195 // When a nodeinfo is present, we don't need to dig further
196 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
197 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
198 if ($curlResult->isTimeout()) {
199 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
203 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
205 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
206 if (empty($nodeinfo)) {
207 $nodeinfo = self::fetchStatistics($url);
210 // If that didn't work out well, we use some protocol specific endpoints
211 // For Friendica and Zot based networks we have to dive deeper to reveal more details
212 if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
213 // Fetch the landing page, possibly it reveals some data
214 if (empty($nodeinfo['network'])) {
215 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
216 if ($curlResult->isSuccess()) {
217 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
218 $serverdata = self::analyseRootBody($curlResult, $serverdata, $url);
221 if (!$curlResult->isSuccess() || empty($curlResult->getBody()) || self::invalidBody($curlResult->getBody())) {
222 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
227 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
228 $serverdata = self::detectMastodonAlikes($url, $serverdata);
231 // All following checks are done for systems that always have got a "host-meta" endpoint.
232 // With this check we don't have to waste time and ressources for dead systems.
233 // Also this hopefully prevents us from receiving abuse messages.
234 if (empty($serverdata['network']) && !self::validHostMeta($url)) {
235 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
239 if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
240 $serverdata = self::detectFriendica($url, $serverdata);
243 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
244 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
245 $serverdata = self::fetchSiteinfo($url, $serverdata);
248 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
249 if (empty($serverdata['network'])) {
250 $serverdata = self::detectHubzilla($url, $serverdata);
253 if (empty($serverdata['network'])) {
254 $serverdata = self::detectNextcloud($url, $serverdata);
257 if (empty($serverdata['network'])) {
258 $serverdata = self::detectGNUSocial($url, $serverdata);
261 $serverdata = $nodeinfo;
264 // Detect the directory type
265 $serverdata['directory-type'] = self::DT_NONE;
266 $serverdata = self::checkPoCo($url, $serverdata);
267 $serverdata = self::checkMastodonDirectory($url, $serverdata);
269 // We can't detect the network type. Possibly it is some system that we don't know yet
270 if (empty($serverdata['network'])) {
271 $serverdata['network'] = Protocol::PHANTOM;
274 // When we hadn't been able to detect the network type, we use the hint from the parameter
275 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
276 $serverdata['network'] = $network;
279 $serverdata['url'] = $url;
280 $serverdata['nurl'] = Strings::normaliseLink($url);
282 // We take the highest number that we do find
283 $registeredUsers = $serverdata['registered-users'] ?? 0;
285 // On an active server there has to be at least a single user
286 if (($serverdata['network'] != Protocol::PHANTOM) && ($registeredUsers == 0)) {
287 $registeredUsers = 1;
290 if ($serverdata['network'] != Protocol::PHANTOM) {
291 $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
292 $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
293 $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
294 $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
296 $serverdata['registered-users'] = $registeredUsers;
297 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
300 $serverdata['last_contact'] = DateTimeFormat::utcNow();
302 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
303 if (!DBA::isResult($gserver)) {
304 $serverdata['created'] = DateTimeFormat::utcNow();
305 $ret = DBA::insert('gserver', $serverdata);
307 // Don't override the network with 'unknown' when there had been a valid entry before
308 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
309 unset($serverdata['network']);
312 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
315 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
316 self::discoverRelay($url);
323 * Fetch relay data from a given server url
325 * @param string $server_url address of the server
326 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
328 private static function discoverRelay(string $server_url)
330 Logger::info('Discover relay data', ['server' => $server_url]);
332 $curlResult = Network::curl($server_url . '/.well-known/x-social-relay');
333 if (!$curlResult->isSuccess()) {
337 $data = json_decode($curlResult->getBody(), true);
338 if (!is_array($data)) {
342 $gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
343 if (!DBA::isResult($gserver)) {
347 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
348 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
349 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
352 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
354 if ($data['scope'] == 'tags') {
357 foreach ($data['tags'] as $tag) {
358 $tag = mb_strtolower($tag);
359 if (strlen($tag) < 100) {
364 foreach ($tags as $tag) {
365 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], true);
369 // Create or update the relay contact
371 if (isset($data['protocols'])) {
372 if (isset($data['protocols']['diaspora'])) {
373 $fields['network'] = Protocol::DIASPORA;
375 if (isset($data['protocols']['diaspora']['receive'])) {
376 $fields['batch'] = $data['protocols']['diaspora']['receive'];
377 } elseif (is_string($data['protocols']['diaspora'])) {
378 $fields['batch'] = $data['protocols']['diaspora'];
382 if (isset($data['protocols']['dfrn'])) {
383 $fields['network'] = Protocol::DFRN;
385 if (isset($data['protocols']['dfrn']['receive'])) {
386 $fields['batch'] = $data['protocols']['dfrn']['receive'];
387 } elseif (is_string($data['protocols']['dfrn'])) {
388 $fields['batch'] = $data['protocols']['dfrn'];
392 Diaspora::setRelayContact($server_url, $fields);
396 * Fetch server data from '/statistics.json' on the given server
398 * @param string $url URL of the given server
400 * @return array server data
402 private static function fetchStatistics(string $url)
404 $curlResult = Network::curl($url . '/statistics.json');
405 if (!$curlResult->isSuccess()) {
409 $data = json_decode($curlResult->getBody(), true);
416 if (!empty($data['version'])) {
417 $serverdata['version'] = $data['version'];
418 // Version numbers on statistics.json are presented with additional info, e.g.:
419 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
420 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
423 if (!empty($data['name'])) {
424 $serverdata['site_name'] = $data['name'];
427 if (!empty($data['network'])) {
428 $serverdata['platform'] = strtolower($data['network']);
430 if ($serverdata['platform'] == 'diaspora') {
431 $serverdata['network'] = Protocol::DIASPORA;
432 } elseif ($serverdata['platform'] == 'friendica') {
433 $serverdata['network'] = Protocol::DFRN;
434 } elseif ($serverdata['platform'] == 'hubzilla') {
435 $serverdata['network'] = Protocol::ZOT;
436 } elseif ($serverdata['platform'] == 'redmatrix') {
437 $serverdata['network'] = Protocol::ZOT;
442 if (!empty($data['registrations_open'])) {
443 $serverdata['register_policy'] = Register::OPEN;
445 $serverdata['register_policy'] = Register::CLOSED;
452 * Detect server type by using the nodeinfo data
454 * @param string $url address of the server
455 * @param CurlResult $curlResult
456 * @return array Server data
457 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
459 private static function fetchNodeinfo(string $url, CurlResult $curlResult)
461 $nodeinfo = json_decode($curlResult->getBody(), true);
463 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
470 foreach ($nodeinfo['links'] as $link) {
471 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
472 Logger::info('Invalid nodeinfo format', ['url' => $url]);
475 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
476 $nodeinfo1_url = $link['href'];
477 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
478 $nodeinfo2_url = $link['href'];
482 if ($nodeinfo1_url . $nodeinfo2_url == '') {
488 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
489 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
490 $server = self::parseNodeinfo2($nodeinfo2_url);
493 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
494 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
495 $server = self::parseNodeinfo1($nodeinfo1_url);
504 * @param string $nodeinfo_url address of the nodeinfo path
505 * @return array Server data
506 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
508 private static function parseNodeinfo1(string $nodeinfo_url)
510 $curlResult = Network::curl($nodeinfo_url);
512 if (!$curlResult->isSuccess()) {
516 $nodeinfo = json_decode($curlResult->getBody(), true);
518 if (!is_array($nodeinfo)) {
524 $server['register_policy'] = Register::CLOSED;
526 if (!empty($nodeinfo['openRegistrations'])) {
527 $server['register_policy'] = Register::OPEN;
530 if (is_array($nodeinfo['software'])) {
531 if (!empty($nodeinfo['software']['name'])) {
532 $server['platform'] = strtolower($nodeinfo['software']['name']);
535 if (!empty($nodeinfo['software']['version'])) {
536 $server['version'] = $nodeinfo['software']['version'];
537 // Version numbers on Nodeinfo are presented with additional info, e.g.:
538 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
539 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
543 if (!empty($nodeinfo['metadata']['nodeName'])) {
544 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
547 if (!empty($nodeinfo['usage']['users']['total'])) {
548 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
551 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
553 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
554 $protocols[$protocol] = true;
557 if (!empty($protocols['friendica'])) {
558 $server['network'] = Protocol::DFRN;
559 } elseif (!empty($protocols['activitypub'])) {
560 $server['network'] = Protocol::ACTIVITYPUB;
561 } elseif (!empty($protocols['diaspora'])) {
562 $server['network'] = Protocol::DIASPORA;
563 } elseif (!empty($protocols['ostatus'])) {
564 $server['network'] = Protocol::OSTATUS;
565 } elseif (!empty($protocols['gnusocial'])) {
566 $server['network'] = Protocol::OSTATUS;
567 } elseif (!empty($protocols['zot'])) {
568 $server['network'] = Protocol::ZOT;
572 if (empty($server)) {
582 * @param string $nodeinfo_url address of the nodeinfo path
583 * @return array Server data
584 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
586 private static function parseNodeinfo2(string $nodeinfo_url)
588 $curlResult = Network::curl($nodeinfo_url);
589 if (!$curlResult->isSuccess()) {
593 $nodeinfo = json_decode($curlResult->getBody(), true);
595 if (!is_array($nodeinfo)) {
601 $server['register_policy'] = Register::CLOSED;
603 if (!empty($nodeinfo['openRegistrations'])) {
604 $server['register_policy'] = Register::OPEN;
607 if (is_array($nodeinfo['software'])) {
608 if (!empty($nodeinfo['software']['name'])) {
609 $server['platform'] = strtolower($nodeinfo['software']['name']);
612 if (!empty($nodeinfo['software']['version'])) {
613 $server['version'] = $nodeinfo['software']['version'];
614 // Version numbers on Nodeinfo are presented with additional info, e.g.:
615 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
616 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
620 if (!empty($nodeinfo['metadata']['nodeName'])) {
621 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
624 if (!empty($nodeinfo['usage']['users']['total'])) {
625 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
628 if (!empty($nodeinfo['protocols'])) {
630 foreach ($nodeinfo['protocols'] as $protocol) {
631 $protocols[$protocol] = true;
634 if (!empty($protocols['dfrn'])) {
635 $server['network'] = Protocol::DFRN;
636 } elseif (!empty($protocols['activitypub'])) {
637 $server['network'] = Protocol::ACTIVITYPUB;
638 } elseif (!empty($protocols['diaspora'])) {
639 $server['network'] = Protocol::DIASPORA;
640 } elseif (!empty($protocols['ostatus'])) {
641 $server['network'] = Protocol::OSTATUS;
642 } elseif (!empty($protocols['gnusocial'])) {
643 $server['network'] = Protocol::OSTATUS;
644 } elseif (!empty($protocols['zot'])) {
645 $server['network'] = Protocol::ZOT;
649 if (empty($server)) {
657 * Fetch server information from a 'siteinfo.json' file on the given server
659 * @param string $url URL of the given server
660 * @param array $serverdata array with server data
662 * @return array server data
664 private static function fetchSiteinfo(string $url, array $serverdata)
666 $curlResult = Network::curl($url . '/siteinfo.json');
667 if (!$curlResult->isSuccess()) {
671 $data = json_decode($curlResult->getBody(), true);
676 if (!empty($data['url'])) {
677 $serverdata['platform'] = strtolower($data['platform']);
678 $serverdata['version'] = $data['version'];
681 if (!empty($data['plugins'])) {
682 if (in_array('pubcrawl', $data['plugins'])) {
683 $serverdata['network'] = Protocol::ACTIVITYPUB;
684 } elseif (in_array('diaspora', $data['plugins'])) {
685 $serverdata['network'] = Protocol::DIASPORA;
686 } elseif (in_array('gnusoc', $data['plugins'])) {
687 $serverdata['network'] = Protocol::OSTATUS;
689 $serverdata['network'] = Protocol::ZOT;
693 if (!empty($data['site_name'])) {
694 $serverdata['site_name'] = $data['site_name'];
697 if (!empty($data['channels_total'])) {
698 $serverdata['registered-users'] = $data['channels_total'];
701 if (!empty($data['register_policy'])) {
702 switch ($data['register_policy']) {
703 case 'REGISTER_OPEN':
704 $serverdata['register_policy'] = Register::OPEN;
707 case 'REGISTER_APPROVE':
708 $serverdata['register_policy'] = Register::APPROVE;
711 case 'REGISTER_CLOSED':
713 $serverdata['register_policy'] = Register::CLOSED;
722 * Checks if the server contains a valid host meta file
724 * @param string $url URL of the given server
726 * @return boolean 'true' if the server seems to be vital
728 private static function validHostMeta(string $url)
730 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
731 $curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
732 if (!$curlResult->isSuccess()) {
736 $xrd = XML::parseString($curlResult->getBody(), false);
737 if (!is_object($xrd)) {
741 $elements = XML::elementToArray($xrd);
742 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
747 foreach ($elements['xrd']['link'] as $link) {
748 // When there is more than a single "link" element, the array looks slightly different
749 if (!empty($link['@attributes'])) {
750 $link = $link['@attributes'];
753 if (empty($link['rel']) || empty($link['template'])) {
757 if ($link['rel'] == 'lrdd') {
758 // When the webfinger host is the same like the system host, it should be ok.
759 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
767 * Detect the network of the given server via their known contacts
769 * @param string $url URL of the given server
770 * @param array $serverdata array with server data
772 * @return array server data
774 private static function detectNetworkViaContacts(string $url, array $serverdata)
778 $gcontacts = DBA::select('gcontact', ['url', 'nurl'], ['server_url' => [$url, $serverdata['nurl']]]);
779 while ($gcontact = DBA::fetch($gcontacts)) {
780 $contacts[$gcontact['nurl']] = $gcontact['url'];
782 DBA::close($gcontacts);
784 $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
785 while ($gcontact = DBA::fetch($gcontacts)) {
786 $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
788 DBA::close($apcontacts);
790 $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
791 while ($gcontact = DBA::fetch($gcontacts)) {
792 $contacts[$pcontact['nurl']] = $pcontact['url'];
794 DBA::close($pcontacts);
796 if (empty($contacts)) {
800 foreach ($contacts as $contact) {
801 $probed = Probe::uri($contact);
802 if (in_array($probed['network'], Protocol::FEDERATED)) {
803 $serverdata['network'] = $probed['network'];
808 $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
814 * Checks if the given server does have a '/poco' endpoint.
815 * This is used for the 'PortableContact' functionality,
816 * which is used by both Friendica and Hubzilla.
818 * @param string $url URL of the given server
819 * @param array $serverdata array with server data
821 * @return array server data
823 private static function checkPoCo(string $url, array $serverdata)
825 $serverdata['poco'] = '';
827 $curlResult = Network::curl($url. '/poco');
828 if (!$curlResult->isSuccess()) {
832 $data = json_decode($curlResult->getBody(), true);
837 if (!empty($data['totalResults'])) {
838 $registeredUsers = $serverdata['registered-users'] ?? 0;
839 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
840 $serverdata['directory-type'] = self::DT_POCO;
841 $serverdata['poco'] = $url . '/poco';
848 * Checks if the given server does have a Mastodon style directory endpoint.
850 * @param string $url URL of the given server
851 * @param array $serverdata array with server data
853 * @return array server data
855 public static function checkMastodonDirectory(string $url, array $serverdata)
857 $curlResult = Network::curl($url . '/api/v1/directory?limit=1');
858 if (!$curlResult->isSuccess()) {
862 $data = json_decode($curlResult->getBody(), true);
867 if (count($data) == 1) {
868 $serverdata['directory-type'] = self::DT_MASTODON;
875 * Detects the version number of a given server when it was a NextCloud installation
877 * @param string $url URL of the given server
878 * @param array $serverdata array with server data
880 * @return array server data
882 private static function detectNextcloud(string $url, array $serverdata)
884 $curlResult = Network::curl($url . '/status.php');
886 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
890 $data = json_decode($curlResult->getBody(), true);
895 if (!empty($data['version'])) {
896 $serverdata['platform'] = 'nextcloud';
897 $serverdata['version'] = $data['version'];
898 $serverdata['network'] = Protocol::ACTIVITYPUB;
905 * Detects data from a given server url if it was a mastodon alike system
907 * @param string $url URL of the given server
908 * @param array $serverdata array with server data
910 * @return array server data
912 private static function detectMastodonAlikes(string $url, array $serverdata)
914 $curlResult = Network::curl($url . '/api/v1/instance');
916 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
920 $data = json_decode($curlResult->getBody(), true);
925 if (!empty($data['version'])) {
926 $serverdata['platform'] = 'mastodon';
927 $serverdata['version'] = $data['version'] ?? '';
928 $serverdata['network'] = Protocol::ACTIVITYPUB;
931 if (!empty($data['title'])) {
932 $serverdata['site_name'] = $data['title'];
935 if (!empty($data['title']) && empty($serverdata['platform']) && empty($serverdata['network'])) {
936 $serverdata['platform'] = 'mastodon';
937 $serverdata['network'] = Protocol::ACTIVITYPUB;
940 if (!empty($data['description'])) {
941 $serverdata['info'] = trim($data['description']);
944 if (!empty($data['stats']['user_count'])) {
945 $serverdata['registered-users'] = $data['stats']['user_count'];
948 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
949 $serverdata['platform'] = strtolower($matches[1]);
950 $serverdata['version'] = $matches[2];
953 if (!empty($serverdata['version']) && strstr(strtolower($serverdata['version']), 'pleroma')) {
954 $serverdata['platform'] = 'pleroma';
955 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
958 if (!empty($serverdata['platform']) && strstr($serverdata['platform'], 'pleroma')) {
959 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['platform']));
960 $serverdata['platform'] = 'pleroma';
967 * Detects data from typical Hubzilla endpoints
969 * @param string $url URL of the given server
970 * @param array $serverdata array with server data
972 * @return array server data
974 private static function detectHubzilla(string $url, array $serverdata)
976 $curlResult = Network::curl($url . '/api/statusnet/config.json');
977 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
981 $data = json_decode($curlResult->getBody(), true);
986 if (!empty($data['site']['name'])) {
987 $serverdata['site_name'] = $data['site']['name'];
990 if (!empty($data['site']['platform'])) {
991 $serverdata['platform'] = strtolower($data['site']['platform']['PLATFORM_NAME']);
992 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
993 $serverdata['network'] = Protocol::ZOT;
996 if (!empty($data['site']['hubzilla'])) {
997 $serverdata['platform'] = strtolower($data['site']['hubzilla']['PLATFORM_NAME']);
998 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
999 $serverdata['network'] = Protocol::ZOT;
1002 if (!empty($data['site']['redmatrix'])) {
1003 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
1004 $serverdata['platform'] = strtolower($data['site']['redmatrix']['PLATFORM_NAME']);
1005 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
1006 $serverdata['platform'] = strtolower($data['site']['redmatrix']['RED_PLATFORM']);
1009 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
1010 $serverdata['network'] = Protocol::ZOT;
1014 $inviteonly = false;
1017 if (!empty($data['site']['closed'])) {
1018 $closed = self::toBoolean($data['site']['closed']);
1021 if (!empty($data['site']['private'])) {
1022 $private = self::toBoolean($data['site']['private']);
1025 if (!empty($data['site']['inviteonly'])) {
1026 $inviteonly = self::toBoolean($data['site']['inviteonly']);
1029 if (!$closed && !$private and $inviteonly) {
1030 $register_policy = Register::APPROVE;
1031 } elseif (!$closed && !$private) {
1032 $register_policy = Register::OPEN;
1034 $register_policy = Register::CLOSED;
1041 * Converts input value to a boolean value
1043 * @param string|integer $val
1047 private static function toBoolean($val)
1049 if (($val == 'true') || ($val == 1)) {
1051 } elseif (($val == 'false') || ($val == 0)) {
1059 * Detect if the URL belongs to a GNU Social server
1061 * @param string $url URL of the given server
1062 * @param array $serverdata array with server data
1064 * @return array server data
1066 private static function detectGNUSocial(string $url, array $serverdata)
1068 // Test for GNU Social
1069 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
1070 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1071 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1072 $serverdata['platform'] = 'gnusocial';
1073 // Remove junk that some GNU Social servers return
1074 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
1075 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1076 $serverdata['version'] = trim($serverdata['version'], '"');
1077 $serverdata['network'] = Protocol::OSTATUS;
1081 // Test for Statusnet
1082 $curlResult = Network::curl($url . '/api/statusnet/version.json');
1083 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1084 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1086 // Remove junk that some GNU Social servers return
1087 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
1088 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1089 $serverdata['version'] = trim($serverdata['version'], '"');
1091 if (!empty($serverdata['version']) && strtolower(substr($serverdata['version'], 0, 7)) == 'pleroma') {
1092 $serverdata['platform'] = 'pleroma';
1093 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1094 $serverdata['network'] = Protocol::ACTIVITYPUB;
1096 $serverdata['platform'] = 'statusnet';
1097 $serverdata['network'] = Protocol::OSTATUS;
1105 * Detect if the URL belongs to a Friendica server
1107 * @param string $url URL of the given server
1108 * @param array $serverdata array with server data
1110 * @return array server data
1112 private static function detectFriendica(string $url, array $serverdata)
1114 $curlResult = Network::curl($url . '/friendica/json');
1115 if (!$curlResult->isSuccess()) {
1116 $curlResult = Network::curl($url . '/friendika/json');
1119 if (!$curlResult->isSuccess()) {
1123 $data = json_decode($curlResult->getBody(), true);
1124 if (empty($data) || empty($data['version'])) {
1128 $serverdata['network'] = Protocol::DFRN;
1129 $serverdata['version'] = $data['version'];
1131 if (!empty($data['no_scrape_url'])) {
1132 $serverdata['noscrape'] = $data['no_scrape_url'];
1135 if (!empty($data['site_name'])) {
1136 $serverdata['site_name'] = $data['site_name'];
1139 if (!empty($data['info'])) {
1140 $serverdata['info'] = trim($data['info']);
1143 $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
1144 switch ($register_policy) {
1145 case 'REGISTER_OPEN':
1146 $serverdata['register_policy'] = Register::OPEN;
1149 case 'REGISTER_APPROVE':
1150 $serverdata['register_policy'] = Register::APPROVE;
1153 case 'REGISTER_CLOSED':
1154 case 'REGISTER_INVITATION':
1155 $serverdata['register_policy'] = Register::CLOSED;
1158 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
1159 $serverdata['register_policy'] = Register::CLOSED;
1163 $serverdata['platform'] = strtolower($data['platform'] ?? '');
1169 * Analyses the landing page of a given server for hints about type and system of that server
1171 * @param object $curlResult result of curl execution
1172 * @param array $serverdata array with server data
1173 * @param string $url Server URL
1175 * @return array server data
1177 private static function analyseRootBody($curlResult, array $serverdata, string $url)
1179 $doc = new DOMDocument();
1180 @$doc->loadHTML($curlResult->getBody());
1181 $xpath = new DOMXPath($doc);
1183 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1184 if (!empty($title)) {
1185 $serverdata['site_name'] = $title;
1188 $list = $xpath->query('//meta[@name]');
1190 foreach ($list as $node) {
1192 if ($node->attributes->length) {
1193 foreach ($node->attributes as $attribute) {
1194 $value = trim($attribute->value);
1195 if (empty($value)) {
1199 $attr[$attribute->name] = $value;
1202 if (empty($attr['name']) || empty($attr['content'])) {
1207 if ($attr['name'] == 'description') {
1208 $serverdata['info'] = $attr['content'];
1211 if ($attr['name'] == 'application-name') {
1212 $serverdata['platform'] = strtolower($attr['content']);
1213 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1214 $serverdata['network'] = Protocol::ACTIVITYPUB;
1217 if (($attr['name'] == 'generator') && (empty($serverdata['platform']) || (substr(strtolower($attr['content']), 0, 9) == 'wordpress'))) {
1218 $serverdata['platform'] = strtolower($attr['content']);
1219 $version_part = explode(' ', $attr['content']);
1221 if (count($version_part) == 2) {
1222 if (in_array($version_part[0], ['WordPress'])) {
1223 $serverdata['platform'] = strtolower($version_part[0]);
1224 $serverdata['version'] = $version_part[1];
1226 // We still do need a reliable test if some AP plugin is activated
1227 if (DBA::exists('apcontact', ['baseurl' => $url])) {
1228 $serverdata['network'] = Protocol::ACTIVITYPUB;
1230 $serverdata['network'] = Protocol::FEED;
1233 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1234 $serverdata['platform'] = strtolower($version_part[0]);
1235 $serverdata['version'] = $version_part[1];
1236 $serverdata['network'] = Protocol::DFRN;
1242 $list = $xpath->query('//meta[@property]');
1244 foreach ($list as $node) {
1246 if ($node->attributes->length) {
1247 foreach ($node->attributes as $attribute) {
1248 $value = trim($attribute->value);
1249 if (empty($value)) {
1253 $attr[$attribute->name] = $value;
1256 if (empty($attr['property']) || empty($attr['content'])) {
1261 if ($attr['property'] == 'og:site_name') {
1262 $serverdata['site_name'] = $attr['content'];
1265 if ($attr['property'] == 'og:description') {
1266 $serverdata['info'] = $attr['content'];
1269 if ($attr['property'] == 'og:platform') {
1270 $serverdata['platform'] = strtolower($attr['content']);
1272 if (in_array($attr['content'], ['PeerTube'])) {
1273 $serverdata['network'] = Protocol::ACTIVITYPUB;
1277 if ($attr['property'] == 'generator') {
1278 $serverdata['platform'] = strtolower($attr['content']);
1280 if (in_array($attr['content'], ['hubzilla'])) {
1281 // We later check which compatible protocol modules are loaded.
1282 $serverdata['network'] = Protocol::ZOT;
1291 * Analyses the header data of a given server for hints about type and system of that server
1293 * @param object $curlResult result of curl execution
1294 * @param array $serverdata array with server data
1296 * @return array server data
1298 private static function analyseRootHeader($curlResult, array $serverdata)
1300 if ($curlResult->getHeader('server') == 'Mastodon') {
1301 $serverdata['platform'] = 'mastodon';
1302 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
1303 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1304 $serverdata['platform'] = 'diaspora';
1305 $serverdata['network'] = $network = Protocol::DIASPORA;
1306 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
1307 } elseif ($curlResult->inHeader('x-friendica-version')) {
1308 $serverdata['platform'] = 'friendica';
1309 $serverdata['network'] = $network = Protocol::DFRN;
1310 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');
1316 * Test if the body contains valid content
1318 * @param string $body
1321 private static function invalidBody(string $body)
1323 // Currently we only test for a HTML element.
1324 // Possibly we enhance this in the future.
1325 return !strpos($body, '>');
1329 * Update the user directory of a given gserver record
1331 * @param array $gserver gserver record
1333 public static function updateDirectory(array $gserver)
1335 /// @todo Add Mastodon API directory
1337 if (!empty($gserver['poco'])) {
1338 PortableContact::discoverSingleServer($gserver['id']);
1343 * Update GServer entries
1345 public static function discover()
1347 // Update the server list
1348 self::discoverFederation();
1352 $requery_days = intval(DI::config()->get('system', 'poco_requery_days'));
1354 if ($requery_days == 0) {
1358 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
1360 $gservers = DBA::p("SELECT `id`, `url`, `nurl`, `network`, `poco`
1362 WHERE `last_contact` >= `last_failure`
1364 AND `last_poco_query` < ?
1365 ORDER BY RAND()", $last_update
1368 while ($gserver = DBA::fetch($gservers)) {
1369 if (!GServer::check($gserver['url'], $gserver['network'])) {
1370 // The server is not reachable? Okay, then we will try it later
1371 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
1372 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
1376 Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
1377 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
1379 if (--$no_of_queries == 0) {
1384 DBA::close($gservers);
1388 * Discover federated servers
1390 private static function discoverFederation()
1392 $last = DI::config()->get('poco', 'last_federation_discovery');
1395 $next = $last + (24 * 60 * 60);
1397 if ($next > time()) {
1402 // Discover federated servers
1403 $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
1405 if (!empty($curlResult)) {
1406 $servers = json_decode($curlResult, true);
1408 if (!empty($servers['pods'])) {
1409 foreach ($servers['pods'] as $server) {
1410 Worker::add(PRIORITY_LOW, 'UpdateGServer', 'https://' . $server['host']);
1415 // Disvover Mastodon servers
1416 $accesstoken = DI::config()->get('system', 'instances_social_key');
1418 if (!empty($accesstoken)) {
1419 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1420 $header = ['Authorization: Bearer '.$accesstoken];
1421 $curlResult = Network::curl($api, false, ['headers' => $header]);
1423 if ($curlResult->isSuccess()) {
1424 $servers = json_decode($curlResult->getBody(), true);
1426 foreach ($servers['instances'] as $server) {
1427 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
1428 Worker::add(PRIORITY_LOW, 'UpdateGServer', $url);
1433 DI::config()->set('poco', 'last_federation_discovery', time());