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\Protocol;
12 use Friendica\Core\Worker;
13 use Friendica\Database\DBA;
15 use Friendica\Module\Register;
16 use Friendica\Network\CurlResult;
17 use Friendica\Util\Network;
18 use Friendica\Util\DateTimeFormat;
19 use Friendica\Util\Strings;
20 use Friendica\Util\XML;
21 use Friendica\Core\Logger;
22 use Friendica\Protocol\PortableContact;
23 use Friendica\Protocol\Diaspora;
24 use Friendica\Network\Probe;
27 * This class handles GServer related functions
34 const DT_MASTODON = 2;
36 * Checks if the given server is reachable
38 * @param string $profile URL of the given profile
39 * @param string $server URL of the given server (If empty, taken from profile)
40 * @param string $network Network value that is used, when detection failed
41 * @param boolean $force Force an update.
43 * @return boolean 'true' if server seems vital
45 public static function reachable(string $profile, string $server = '', string $network = '', bool $force = false)
48 $server = GContact::getBasepath($profile);
55 return self::check($server, $network, $force);
59 * Decides if a server needs to be updated, based upon several date fields
61 * @param date $created Creation date of that server entry
62 * @param date $updated When had the server entry be updated
63 * @param date $last_failure Last failure when contacting that server
64 * @param date $last_contact Last time the server had been contacted
66 * @return boolean Does the server record needs an update?
68 public static function updateNeeded($created, $updated, $last_failure, $last_contact)
70 $now = strtotime(DateTimeFormat::utcNow());
72 if ($updated > $last_contact) {
73 $contact_time = strtotime($updated);
75 $contact_time = strtotime($last_contact);
78 $failure_time = strtotime($last_failure);
79 $created_time = strtotime($created);
81 // If there is no "created" time then use the current time
82 if ($created_time <= 0) {
86 // If the last contact was less than 24 hours then don't update
87 if (($now - $contact_time) < (60 * 60 * 24)) {
91 // If the last failure was less than 24 hours then don't update
92 if (($now - $failure_time) < (60 * 60 * 24)) {
96 // If the last contact was less than a week ago and the last failure is older than a week then don't update
97 //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
100 // 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
101 if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
105 // 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
106 if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
114 * Checks the state of the given server.
116 * @param string $server_url URL of the given server
117 * @param string $network Network value that is used, when detection failed
118 * @param boolean $force Force an update.
120 * @return boolean 'true' if server seems vital
122 public static function check(string $server_url, string $network = '', bool $force = false)
124 // Unify the server address
125 $server_url = trim($server_url, '/');
126 $server_url = str_replace('/index.php', '', $server_url);
128 if ($server_url == '') {
132 $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($server_url)]);
133 if (DBA::isResult($gserver)) {
134 if ($gserver['created'] <= DBA::NULL_DATETIME) {
135 $fields = ['created' => DateTimeFormat::utcNow()];
136 $condition = ['nurl' => Strings::normaliseLink($server_url)];
137 DBA::update('gserver', $fields, $condition);
140 $last_contact = $gserver['last_contact'];
141 $last_failure = $gserver['last_failure'];
143 // See discussion under https://forum.friendi.ca/display/0b6b25a8135aabc37a5a0f5684081633
144 // It can happen that a zero date is in the database, but storing it again is forbidden.
145 if ($last_contact < DBA::NULL_DATETIME) {
146 $last_contact = DBA::NULL_DATETIME;
149 if ($last_failure < DBA::NULL_DATETIME) {
150 $last_failure = DBA::NULL_DATETIME;
153 if (!$force && !self::updateNeeded($gserver['created'], '', $last_failure, $last_contact)) {
154 Logger::info('No update needed', ['server' => $server_url]);
155 return ($last_contact >= $last_failure);
157 Logger::info('Server is outdated. Start discovery.', ['Server' => $server_url, 'Force' => $force, 'Created' => $gserver['created'], 'Failure' => $last_failure, 'Contact' => $last_contact]);
159 Logger::info('Server is unknown. Start discovery.', ['Server' => $server_url]);
162 return self::detect($server_url, $network);
166 * Detect server data (type, protocol, version number, ...)
167 * The detected data is then updated or inserted in the gserver table.
169 * @param string $url URL of the given server
170 * @param string $network Network value that is used, when detection failed
172 * @return boolean 'true' if server could be detected
174 public static function detect(string $url, string $network = '')
176 Logger::info('Detect server type', ['server' => $url]);
179 $original_url = $url;
181 // Remove URL content that is not supposed to exist for a server url
182 $urlparts = parse_url($url);
183 unset($urlparts['user']);
184 unset($urlparts['pass']);
185 unset($urlparts['query']);
186 unset($urlparts['fragment']);
187 $url = Network::unparseURL($urlparts);
189 // If the URL missmatches, then we mark the old entry as failure
190 if ($url != $original_url) {
191 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($original_url)]);
194 // When a nodeinfo is present, we don't need to dig further
195 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
196 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
197 if ($curlResult->isTimeout()) {
198 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
202 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
204 // When nodeinfo isn't present, we use the older 'statistics.json' endpoint
205 if (empty($nodeinfo)) {
206 $nodeinfo = self::fetchStatistics($url);
209 // If that didn't work out well, we use some protocol specific endpoints
210 // For Friendica and Zot based networks we have to dive deeper to reveal more details
211 if (empty($nodeinfo['network']) || in_array($nodeinfo['network'], [Protocol::DFRN, Protocol::ZOT])) {
212 // Fetch the landing page, possibly it reveals some data
213 if (empty($nodeinfo['network'])) {
214 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
215 if ($curlResult->isSuccess()) {
216 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
217 $serverdata = self::analyseRootBody($curlResult, $serverdata, $url);
220 if (!$curlResult->isSuccess() || empty($curlResult->getBody()) || self::invalidBody($curlResult->getBody())) {
221 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
226 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
227 $serverdata = self::detectMastodonAlikes($url, $serverdata);
230 // All following checks are done for systems that always have got a "host-meta" endpoint.
231 // With this check we don't have to waste time and ressources for dead systems.
232 // Also this hopefully prevents us from receiving abuse messages.
233 if (empty($serverdata['network']) && !self::validHostMeta($url)) {
234 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
238 if (empty($serverdata['network']) || in_array($serverdata['network'], [Protocol::DFRN, Protocol::ACTIVITYPUB])) {
239 $serverdata = self::detectFriendica($url, $serverdata);
242 // the 'siteinfo.json' is some specific endpoint of Hubzilla and Red
243 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ZOT)) {
244 $serverdata = self::fetchSiteinfo($url, $serverdata);
247 // The 'siteinfo.json' doesn't seem to be present on older Hubzilla installations
248 if (empty($serverdata['network'])) {
249 $serverdata = self::detectHubzilla($url, $serverdata);
252 if (empty($serverdata['network'])) {
253 $serverdata = self::detectNextcloud($url, $serverdata);
256 if (empty($serverdata['network'])) {
257 $serverdata = self::detectGNUSocial($url, $serverdata);
260 $serverdata = $nodeinfo;
263 // Detect the directory type
264 $serverdata['directory-type'] = self::DT_NONE;
265 $serverdata = self::checkPoCo($url, $serverdata);
266 $serverdata = self::checkMastodonDirectory($url, $serverdata);
268 // We can't detect the network type. Possibly it is some system that we don't know yet
269 if (empty($serverdata['network'])) {
270 $serverdata['network'] = Protocol::PHANTOM;
273 // When we hadn't been able to detect the network type, we use the hint from the parameter
274 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($network)) {
275 $serverdata['network'] = $network;
278 $serverdata['url'] = $url;
279 $serverdata['nurl'] = Strings::normaliseLink($url);
281 // We take the highest number that we do find
282 $registeredUsers = $serverdata['registered-users'] ?? 0;
284 // On an active server there has to be at least a single user
285 if (($serverdata['network'] != Protocol::PHANTOM) && ($registeredUsers == 0)) {
286 $registeredUsers = 1;
289 if ($serverdata['network'] != Protocol::PHANTOM) {
290 $gcontacts = DBA::count('gcontact', ['server_url' => [$url, $serverdata['nurl']]]);
291 $apcontacts = DBA::count('apcontact', ['baseurl' => [$url, $serverdata['nurl']]]);
292 $contacts = DBA::count('contact', ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
293 $serverdata['registered-users'] = max($gcontacts, $apcontacts, $contacts, $registeredUsers);
295 $serverdata['registered-users'] = $registeredUsers;
296 $serverdata = self::detectNetworkViaContacts($url, $serverdata);
299 $serverdata['last_contact'] = DateTimeFormat::utcNow();
301 $gserver = DBA::selectFirst('gserver', ['network'], ['nurl' => Strings::normaliseLink($url)]);
302 if (!DBA::isResult($gserver)) {
303 $serverdata['created'] = DateTimeFormat::utcNow();
304 $ret = DBA::insert('gserver', $serverdata);
306 // Don't override the network with 'unknown' when there had been a valid entry before
307 if (($serverdata['network'] == Protocol::PHANTOM) && !empty($gserver['network'])) {
308 unset($serverdata['network']);
311 $ret = DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']]);
314 if (!empty($serverdata['network']) && in_array($serverdata['network'], [Protocol::DFRN, Protocol::DIASPORA])) {
315 self::discoverRelay($url);
322 * Fetch relay data from a given server url
324 * @param string $server_url address of the server
325 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
327 private static function discoverRelay(string $server_url)
329 Logger::info('Discover relay data', ['server' => $server_url]);
331 $curlResult = Network::curl($server_url . '/.well-known/x-social-relay');
332 if (!$curlResult->isSuccess()) {
336 $data = json_decode($curlResult->getBody(), true);
337 if (!is_array($data)) {
341 $gserver = DBA::selectFirst('gserver', ['id', 'relay-subscribe', 'relay-scope'], ['nurl' => Strings::normaliseLink($server_url)]);
342 if (!DBA::isResult($gserver)) {
346 if (($gserver['relay-subscribe'] != $data['subscribe']) || ($gserver['relay-scope'] != $data['scope'])) {
347 $fields = ['relay-subscribe' => $data['subscribe'], 'relay-scope' => $data['scope']];
348 DBA::update('gserver', $fields, ['id' => $gserver['id']]);
351 DBA::delete('gserver-tag', ['gserver-id' => $gserver['id']]);
353 if ($data['scope'] == 'tags') {
356 foreach ($data['tags'] as $tag) {
357 $tag = mb_strtolower($tag);
358 if (strlen($tag) < 100) {
363 foreach ($tags as $tag) {
364 DBA::insert('gserver-tag', ['gserver-id' => $gserver['id'], 'tag' => $tag], true);
368 // Create or update the relay contact
370 if (isset($data['protocols'])) {
371 if (isset($data['protocols']['diaspora'])) {
372 $fields['network'] = Protocol::DIASPORA;
374 if (isset($data['protocols']['diaspora']['receive'])) {
375 $fields['batch'] = $data['protocols']['diaspora']['receive'];
376 } elseif (is_string($data['protocols']['diaspora'])) {
377 $fields['batch'] = $data['protocols']['diaspora'];
381 if (isset($data['protocols']['dfrn'])) {
382 $fields['network'] = Protocol::DFRN;
384 if (isset($data['protocols']['dfrn']['receive'])) {
385 $fields['batch'] = $data['protocols']['dfrn']['receive'];
386 } elseif (is_string($data['protocols']['dfrn'])) {
387 $fields['batch'] = $data['protocols']['dfrn'];
391 Diaspora::setRelayContact($server_url, $fields);
395 * Fetch server data from '/statistics.json' on the given server
397 * @param string $url URL of the given server
399 * @return array server data
401 private static function fetchStatistics(string $url)
403 $curlResult = Network::curl($url . '/statistics.json');
404 if (!$curlResult->isSuccess()) {
408 $data = json_decode($curlResult->getBody(), true);
415 if (!empty($data['version'])) {
416 $serverdata['version'] = $data['version'];
417 // Version numbers on statistics.json are presented with additional info, e.g.:
418 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
419 $serverdata['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $serverdata['version']);
422 if (!empty($data['name'])) {
423 $serverdata['site_name'] = $data['name'];
426 if (!empty($data['network'])) {
427 $serverdata['platform'] = strtolower($data['network']);
429 if ($serverdata['platform'] == 'diaspora') {
430 $serverdata['network'] = Protocol::DIASPORA;
431 } elseif ($serverdata['platform'] == 'friendica') {
432 $serverdata['network'] = Protocol::DFRN;
433 } elseif ($serverdata['platform'] == 'hubzilla') {
434 $serverdata['network'] = Protocol::ZOT;
435 } elseif ($serverdata['platform'] == 'redmatrix') {
436 $serverdata['network'] = Protocol::ZOT;
441 if (!empty($data['registrations_open'])) {
442 $serverdata['register_policy'] = Register::OPEN;
444 $serverdata['register_policy'] = Register::CLOSED;
451 * Detect server type by using the nodeinfo data
453 * @param string $url address of the server
454 * @param CurlResult $curlResult
455 * @return array Server data
456 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
458 private static function fetchNodeinfo(string $url, CurlResult $curlResult)
460 $nodeinfo = json_decode($curlResult->getBody(), true);
462 if (!is_array($nodeinfo) || empty($nodeinfo['links'])) {
469 foreach ($nodeinfo['links'] as $link) {
470 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
471 Logger::info('Invalid nodeinfo format', ['url' => $url]);
474 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
475 $nodeinfo1_url = $link['href'];
476 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
477 $nodeinfo2_url = $link['href'];
481 if ($nodeinfo1_url . $nodeinfo2_url == '') {
487 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
488 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
489 $server = self::parseNodeinfo2($nodeinfo2_url);
492 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
493 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
494 $server = self::parseNodeinfo1($nodeinfo1_url);
503 * @param string $nodeinfo_url address of the nodeinfo path
504 * @return array Server data
505 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
507 private static function parseNodeinfo1(string $nodeinfo_url)
509 $curlResult = Network::curl($nodeinfo_url);
511 if (!$curlResult->isSuccess()) {
515 $nodeinfo = json_decode($curlResult->getBody(), true);
517 if (!is_array($nodeinfo)) {
523 $server['register_policy'] = Register::CLOSED;
525 if (!empty($nodeinfo['openRegistrations'])) {
526 $server['register_policy'] = Register::OPEN;
529 if (is_array($nodeinfo['software'])) {
530 if (!empty($nodeinfo['software']['name'])) {
531 $server['platform'] = strtolower($nodeinfo['software']['name']);
534 if (!empty($nodeinfo['software']['version'])) {
535 $server['version'] = $nodeinfo['software']['version'];
536 // Version numbers on Nodeinfo are presented with additional info, e.g.:
537 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
538 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
542 if (!empty($nodeinfo['metadata']['nodeName'])) {
543 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
546 if (!empty($nodeinfo['usage']['users']['total'])) {
547 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
550 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
552 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
553 $protocols[$protocol] = true;
556 if (!empty($protocols['friendica'])) {
557 $server['network'] = Protocol::DFRN;
558 } elseif (!empty($protocols['activitypub'])) {
559 $server['network'] = Protocol::ACTIVITYPUB;
560 } elseif (!empty($protocols['diaspora'])) {
561 $server['network'] = Protocol::DIASPORA;
562 } elseif (!empty($protocols['ostatus'])) {
563 $server['network'] = Protocol::OSTATUS;
564 } elseif (!empty($protocols['gnusocial'])) {
565 $server['network'] = Protocol::OSTATUS;
566 } elseif (!empty($protocols['zot'])) {
567 $server['network'] = Protocol::ZOT;
571 if (empty($server)) {
581 * @param string $nodeinfo_url address of the nodeinfo path
582 * @return array Server data
583 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
585 private static function parseNodeinfo2(string $nodeinfo_url)
587 $curlResult = Network::curl($nodeinfo_url);
588 if (!$curlResult->isSuccess()) {
592 $nodeinfo = json_decode($curlResult->getBody(), true);
594 if (!is_array($nodeinfo)) {
600 $server['register_policy'] = Register::CLOSED;
602 if (!empty($nodeinfo['openRegistrations'])) {
603 $server['register_policy'] = Register::OPEN;
606 if (is_array($nodeinfo['software'])) {
607 if (!empty($nodeinfo['software']['name'])) {
608 $server['platform'] = strtolower($nodeinfo['software']['name']);
611 if (!empty($nodeinfo['software']['version'])) {
612 $server['version'] = $nodeinfo['software']['version'];
613 // Version numbers on Nodeinfo are presented with additional info, e.g.:
614 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
615 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
619 if (!empty($nodeinfo['metadata']['nodeName'])) {
620 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
623 if (!empty($nodeinfo['usage']['users']['total'])) {
624 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
627 if (!empty($nodeinfo['protocols'])) {
629 foreach ($nodeinfo['protocols'] as $protocol) {
630 $protocols[$protocol] = true;
633 if (!empty($protocols['dfrn'])) {
634 $server['network'] = Protocol::DFRN;
635 } elseif (!empty($protocols['activitypub'])) {
636 $server['network'] = Protocol::ACTIVITYPUB;
637 } elseif (!empty($protocols['diaspora'])) {
638 $server['network'] = Protocol::DIASPORA;
639 } elseif (!empty($protocols['ostatus'])) {
640 $server['network'] = Protocol::OSTATUS;
641 } elseif (!empty($protocols['gnusocial'])) {
642 $server['network'] = Protocol::OSTATUS;
643 } elseif (!empty($protocols['zot'])) {
644 $server['network'] = Protocol::ZOT;
648 if (empty($server)) {
656 * Fetch server information from a 'siteinfo.json' file on the given server
658 * @param string $url URL of the given server
659 * @param array $serverdata array with server data
661 * @return array server data
663 private static function fetchSiteinfo(string $url, array $serverdata)
665 $curlResult = Network::curl($url . '/siteinfo.json');
666 if (!$curlResult->isSuccess()) {
670 $data = json_decode($curlResult->getBody(), true);
675 if (!empty($data['url'])) {
676 $serverdata['platform'] = strtolower($data['platform']);
677 $serverdata['version'] = $data['version'];
680 if (!empty($data['plugins'])) {
681 if (in_array('pubcrawl', $data['plugins'])) {
682 $serverdata['network'] = Protocol::ACTIVITYPUB;
683 } elseif (in_array('diaspora', $data['plugins'])) {
684 $serverdata['network'] = Protocol::DIASPORA;
685 } elseif (in_array('gnusoc', $data['plugins'])) {
686 $serverdata['network'] = Protocol::OSTATUS;
688 $serverdata['network'] = Protocol::ZOT;
692 if (!empty($data['site_name'])) {
693 $serverdata['site_name'] = $data['site_name'];
696 if (!empty($data['channels_total'])) {
697 $serverdata['registered-users'] = $data['channels_total'];
700 if (!empty($data['register_policy'])) {
701 switch ($data['register_policy']) {
702 case 'REGISTER_OPEN':
703 $serverdata['register_policy'] = Register::OPEN;
706 case 'REGISTER_APPROVE':
707 $serverdata['register_policy'] = Register::APPROVE;
710 case 'REGISTER_CLOSED':
712 $serverdata['register_policy'] = Register::CLOSED;
721 * Checks if the server contains a valid host meta file
723 * @param string $url URL of the given server
725 * @return boolean 'true' if the server seems to be vital
727 private static function validHostMeta(string $url)
729 $xrd_timeout = DI::config()->get('system', 'xrd_timeout');
730 $curlResult = Network::curl($url . '/.well-known/host-meta', false, ['timeout' => $xrd_timeout]);
731 if (!$curlResult->isSuccess()) {
735 $xrd = XML::parseString($curlResult->getBody(), false);
736 if (!is_object($xrd)) {
740 $elements = XML::elementToArray($xrd);
741 if (empty($elements) || empty($elements['xrd']) || empty($elements['xrd']['link'])) {
746 foreach ($elements['xrd']['link'] as $link) {
747 // When there is more than a single "link" element, the array looks slightly different
748 if (!empty($link['@attributes'])) {
749 $link = $link['@attributes'];
752 if (empty($link['rel']) || empty($link['template'])) {
756 if ($link['rel'] == 'lrdd') {
757 // When the webfinger host is the same like the system host, it should be ok.
758 $valid = (parse_url($url, PHP_URL_HOST) == parse_url($link['template'], PHP_URL_HOST));
766 * Detect the network of the given server via their known contacts
768 * @param string $url URL of the given server
769 * @param array $serverdata array with server data
771 * @return array server data
773 private static function detectNetworkViaContacts(string $url, array $serverdata)
777 $gcontacts = DBA::select('gcontact', ['url', 'nurl'], ['server_url' => [$url, $serverdata['nurl']]]);
778 while ($gcontact = DBA::fetch($gcontacts)) {
779 $contacts[$gcontact['nurl']] = $gcontact['url'];
781 DBA::close($gcontacts);
783 $apcontacts = DBA::select('apcontact', ['url'], ['baseurl' => [$url, $serverdata['nurl']]]);
784 while ($gcontact = DBA::fetch($gcontacts)) {
785 $contacts[Strings::normaliseLink($apcontact['url'])] = $apcontact['url'];
787 DBA::close($apcontacts);
789 $pcontacts = DBA::select('contact', ['url', 'nurl'], ['uid' => 0, 'baseurl' => [$url, $serverdata['nurl']]]);
790 while ($gcontact = DBA::fetch($gcontacts)) {
791 $contacts[$pcontact['nurl']] = $pcontact['url'];
793 DBA::close($pcontacts);
795 if (empty($contacts)) {
799 foreach ($contacts as $contact) {
800 $probed = Probe::uri($contact);
801 if (in_array($probed['network'], Protocol::FEDERATED)) {
802 $serverdata['network'] = $probed['network'];
807 $serverdata['registered-users'] = max($serverdata['registered-users'], count($contacts));
813 * Checks if the given server does have a '/poco' endpoint.
814 * This is used for the 'PortableContact' functionality,
815 * which is used by both Friendica and Hubzilla.
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 checkPoCo(string $url, array $serverdata)
824 $serverdata['poco'] = '';
826 $curlResult = Network::curl($url. '/poco');
827 if (!$curlResult->isSuccess()) {
831 $data = json_decode($curlResult->getBody(), true);
836 if (!empty($data['totalResults'])) {
837 $registeredUsers = $serverdata['registered-users'] ?? 0;
838 $serverdata['registered-users'] = max($data['totalResults'], $registeredUsers);
839 $serverdata['directory-type'] = self::DT_POCO;
840 $serverdata['poco'] = $url . '/poco';
847 * Checks if the given server does have a Mastodon style directory endpoint.
849 * @param string $url URL of the given server
850 * @param array $serverdata array with server data
852 * @return array server data
854 public static function checkMastodonDirectory(string $url, array $serverdata)
856 $curlResult = Network::curl($url . '/api/v1/directory?limit=1');
857 if (!$curlResult->isSuccess()) {
861 $data = json_decode($curlResult->getBody(), true);
866 if (count($data) == 1) {
867 $serverdata['directory-type'] = self::DT_MASTODON;
874 * Detects the version number of a given server when it was a NextCloud installation
876 * @param string $url URL of the given server
877 * @param array $serverdata array with server data
879 * @return array server data
881 private static function detectNextcloud(string $url, array $serverdata)
883 $curlResult = Network::curl($url . '/status.php');
885 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
889 $data = json_decode($curlResult->getBody(), true);
894 if (!empty($data['version'])) {
895 $serverdata['platform'] = 'nextcloud';
896 $serverdata['version'] = $data['version'];
897 $serverdata['network'] = Protocol::ACTIVITYPUB;
904 * Detects data from a given server url if it was a mastodon alike system
906 * @param string $url URL of the given server
907 * @param array $serverdata array with server data
909 * @return array server data
911 private static function detectMastodonAlikes(string $url, array $serverdata)
913 $curlResult = Network::curl($url . '/api/v1/instance');
915 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
919 $data = json_decode($curlResult->getBody(), true);
924 if (!empty($data['version'])) {
925 $serverdata['platform'] = 'mastodon';
926 $serverdata['version'] = $data['version'] ?? '';
927 $serverdata['network'] = Protocol::ACTIVITYPUB;
930 if (!empty($data['title'])) {
931 $serverdata['site_name'] = $data['title'];
934 if (!empty($data['title']) && empty($serverdata['platform']) && empty($serverdata['network'])) {
935 $serverdata['platform'] = 'mastodon';
936 $serverdata['network'] = Protocol::ACTIVITYPUB;
939 if (!empty($data['description'])) {
940 $serverdata['info'] = trim($data['description']);
943 if (!empty($data['stats']['user_count'])) {
944 $serverdata['registered-users'] = $data['stats']['user_count'];
947 if (!empty($serverdata['version']) && preg_match('/.*?\(compatible;\s(.*)\s(.*)\)/ism', $serverdata['version'], $matches)) {
948 $serverdata['platform'] = strtolower($matches[1]);
949 $serverdata['version'] = $matches[2];
952 if (!empty($serverdata['version']) && strstr(strtolower($serverdata['version']), 'pleroma')) {
953 $serverdata['platform'] = 'pleroma';
954 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
957 if (!empty($serverdata['platform']) && strstr($serverdata['platform'], 'pleroma')) {
958 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['platform']));
959 $serverdata['platform'] = 'pleroma';
966 * Detects data from typical Hubzilla endpoints
968 * @param string $url URL of the given server
969 * @param array $serverdata array with server data
971 * @return array server data
973 private static function detectHubzilla(string $url, array $serverdata)
975 $curlResult = Network::curl($url . '/api/statusnet/config.json');
976 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
980 $data = json_decode($curlResult->getBody(), true);
985 if (!empty($data['site']['name'])) {
986 $serverdata['site_name'] = $data['site']['name'];
989 if (!empty($data['site']['platform'])) {
990 $serverdata['platform'] = strtolower($data['site']['platform']['PLATFORM_NAME']);
991 $serverdata['version'] = $data['site']['platform']['STD_VERSION'];
992 $serverdata['network'] = Protocol::ZOT;
995 if (!empty($data['site']['hubzilla'])) {
996 $serverdata['platform'] = strtolower($data['site']['hubzilla']['PLATFORM_NAME']);
997 $serverdata['version'] = $data['site']['hubzilla']['RED_VERSION'];
998 $serverdata['network'] = Protocol::ZOT;
1001 if (!empty($data['site']['redmatrix'])) {
1002 if (!empty($data['site']['redmatrix']['PLATFORM_NAME'])) {
1003 $serverdata['platform'] = strtolower($data['site']['redmatrix']['PLATFORM_NAME']);
1004 } elseif (!empty($data['site']['redmatrix']['RED_PLATFORM'])) {
1005 $serverdata['platform'] = strtolower($data['site']['redmatrix']['RED_PLATFORM']);
1008 $serverdata['version'] = $data['site']['redmatrix']['RED_VERSION'];
1009 $serverdata['network'] = Protocol::ZOT;
1013 $inviteonly = false;
1016 if (!empty($data['site']['closed'])) {
1017 $closed = self::toBoolean($data['site']['closed']);
1020 if (!empty($data['site']['private'])) {
1021 $private = self::toBoolean($data['site']['private']);
1024 if (!empty($data['site']['inviteonly'])) {
1025 $inviteonly = self::toBoolean($data['site']['inviteonly']);
1028 if (!$closed && !$private and $inviteonly) {
1029 $register_policy = Register::APPROVE;
1030 } elseif (!$closed && !$private) {
1031 $register_policy = Register::OPEN;
1033 $register_policy = Register::CLOSED;
1040 * Converts input value to a boolean value
1042 * @param string|integer $val
1046 private static function toBoolean($val)
1048 if (($val == 'true') || ($val == 1)) {
1050 } elseif (($val == 'false') || ($val == 0)) {
1058 * Detect if the URL belongs to a GNU Social server
1060 * @param string $url URL of the given server
1061 * @param array $serverdata array with server data
1063 * @return array server data
1065 private static function detectGNUSocial(string $url, array $serverdata)
1067 // Test for GNU Social
1068 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
1069 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1070 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1071 $serverdata['platform'] = 'gnusocial';
1072 // Remove junk that some GNU Social servers return
1073 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
1074 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1075 $serverdata['version'] = trim($serverdata['version'], '"');
1076 $serverdata['network'] = Protocol::OSTATUS;
1080 // Test for Statusnet
1081 $curlResult = Network::curl($url . '/api/statusnet/version.json');
1082 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
1083 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
1085 // Remove junk that some GNU Social servers return
1086 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
1087 $serverdata['version'] = str_replace(["\r", "\n", "\t"], '', $serverdata['version']);
1088 $serverdata['version'] = trim($serverdata['version'], '"');
1090 if (!empty($serverdata['version']) && strtolower(substr($serverdata['version'], 0, 7)) == 'pleroma') {
1091 $serverdata['platform'] = 'pleroma';
1092 $serverdata['version'] = trim(str_ireplace('pleroma', '', $serverdata['version']));
1093 $serverdata['network'] = Protocol::ACTIVITYPUB;
1095 $serverdata['platform'] = 'statusnet';
1096 $serverdata['network'] = Protocol::OSTATUS;
1104 * Detect if the URL belongs to a Friendica server
1106 * @param string $url URL of the given server
1107 * @param array $serverdata array with server data
1109 * @return array server data
1111 private static function detectFriendica(string $url, array $serverdata)
1113 $curlResult = Network::curl($url . '/friendica/json');
1114 if (!$curlResult->isSuccess()) {
1115 $curlResult = Network::curl($url . '/friendika/json');
1118 if (!$curlResult->isSuccess()) {
1122 $data = json_decode($curlResult->getBody(), true);
1123 if (empty($data) || empty($data['version'])) {
1127 $serverdata['network'] = Protocol::DFRN;
1128 $serverdata['version'] = $data['version'];
1130 if (!empty($data['no_scrape_url'])) {
1131 $serverdata['noscrape'] = $data['no_scrape_url'];
1134 if (!empty($data['site_name'])) {
1135 $serverdata['site_name'] = $data['site_name'];
1138 if (!empty($data['info'])) {
1139 $serverdata['info'] = trim($data['info']);
1142 $register_policy = ($data['register_policy'] ?? '') ?: 'REGISTER_CLOSED';
1143 switch ($register_policy) {
1144 case 'REGISTER_OPEN':
1145 $serverdata['register_policy'] = Register::OPEN;
1148 case 'REGISTER_APPROVE':
1149 $serverdata['register_policy'] = Register::APPROVE;
1152 case 'REGISTER_CLOSED':
1153 case 'REGISTER_INVITATION':
1154 $serverdata['register_policy'] = Register::CLOSED;
1157 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
1158 $serverdata['register_policy'] = Register::CLOSED;
1162 $serverdata['platform'] = strtolower($data['platform'] ?? '');
1168 * Analyses the landing page of a given server for hints about type and system of that server
1170 * @param object $curlResult result of curl execution
1171 * @param array $serverdata array with server data
1172 * @param string $url Server URL
1174 * @return array server data
1176 private static function analyseRootBody($curlResult, array $serverdata, string $url)
1178 $doc = new DOMDocument();
1179 @$doc->loadHTML($curlResult->getBody());
1180 $xpath = new DOMXPath($doc);
1182 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
1183 if (!empty($title)) {
1184 $serverdata['site_name'] = $title;
1187 $list = $xpath->query('//meta[@name]');
1189 foreach ($list as $node) {
1191 if ($node->attributes->length) {
1192 foreach ($node->attributes as $attribute) {
1193 $value = trim($attribute->value);
1194 if (empty($value)) {
1198 $attr[$attribute->name] = $value;
1201 if (empty($attr['name']) || empty($attr['content'])) {
1206 if ($attr['name'] == 'description') {
1207 $serverdata['info'] = $attr['content'];
1210 if ($attr['name'] == 'application-name') {
1211 $serverdata['platform'] = strtolower($attr['content']);
1212 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
1213 $serverdata['network'] = Protocol::ACTIVITYPUB;
1216 if (($attr['name'] == 'generator') && (empty($serverdata['platform']) || (substr(strtolower($attr['content']), 0, 9) == 'wordpress'))) {
1217 $serverdata['platform'] = strtolower($attr['content']);
1218 $version_part = explode(' ', $attr['content']);
1220 if (count($version_part) == 2) {
1221 if (in_array($version_part[0], ['WordPress'])) {
1222 $serverdata['platform'] = strtolower($version_part[0]);
1223 $serverdata['version'] = $version_part[1];
1225 // We still do need a reliable test if some AP plugin is activated
1226 if (DBA::exists('apcontact', ['baseurl' => $url])) {
1227 $serverdata['network'] = Protocol::ACTIVITYPUB;
1229 $serverdata['network'] = Protocol::FEED;
1232 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
1233 $serverdata['platform'] = strtolower($version_part[0]);
1234 $serverdata['version'] = $version_part[1];
1235 $serverdata['network'] = Protocol::DFRN;
1241 $list = $xpath->query('//meta[@property]');
1243 foreach ($list as $node) {
1245 if ($node->attributes->length) {
1246 foreach ($node->attributes as $attribute) {
1247 $value = trim($attribute->value);
1248 if (empty($value)) {
1252 $attr[$attribute->name] = $value;
1255 if (empty($attr['property']) || empty($attr['content'])) {
1260 if ($attr['property'] == 'og:site_name') {
1261 $serverdata['site_name'] = $attr['content'];
1264 if ($attr['property'] == 'og:description') {
1265 $serverdata['info'] = $attr['content'];
1268 if ($attr['property'] == 'og:platform') {
1269 $serverdata['platform'] = strtolower($attr['content']);
1271 if (in_array($attr['content'], ['PeerTube'])) {
1272 $serverdata['network'] = Protocol::ACTIVITYPUB;
1276 if ($attr['property'] == 'generator') {
1277 $serverdata['platform'] = strtolower($attr['content']);
1279 if (in_array($attr['content'], ['hubzilla'])) {
1280 // We later check which compatible protocol modules are loaded.
1281 $serverdata['network'] = Protocol::ZOT;
1290 * Analyses the header data of a given server for hints about type and system of that server
1292 * @param object $curlResult result of curl execution
1293 * @param array $serverdata array with server data
1295 * @return array server data
1297 private static function analyseRootHeader($curlResult, array $serverdata)
1299 if ($curlResult->getHeader('server') == 'Mastodon') {
1300 $serverdata['platform'] = 'mastodon';
1301 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
1302 } elseif ($curlResult->inHeader('x-diaspora-version')) {
1303 $serverdata['platform'] = 'diaspora';
1304 $serverdata['network'] = $network = Protocol::DIASPORA;
1305 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
1306 } elseif ($curlResult->inHeader('x-friendica-version')) {
1307 $serverdata['platform'] = 'friendica';
1308 $serverdata['network'] = $network = Protocol::DFRN;
1309 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');
1315 * Test if the body contains valid content
1317 * @param string $body
1320 private static function invalidBody(string $body)
1322 // Currently we only test for a HTML element.
1323 // Possibly we enhance this in the future.
1324 return !strpos($body, '>');
1328 * Update the user directory of a given gserver record
1330 * @param array $gserver gserver record
1332 public static function updateDirectory(array $gserver)
1334 /// @todo Add Mastodon API directory
1336 if (!empty($gserver['poco'])) {
1337 PortableContact::discoverSingleServer($gserver['id']);
1342 * Update GServer entries
1344 public static function discover()
1346 // Update the server list
1347 self::discoverFederation();
1351 $requery_days = intval(DI::config()->get('system', 'poco_requery_days'));
1353 if ($requery_days == 0) {
1357 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
1359 $gservers = DBA::p("SELECT `id`, `url`, `nurl`, `network`, `poco`
1361 WHERE `last_contact` >= `last_failure`
1363 AND `last_poco_query` < ?
1364 ORDER BY RAND()", $last_update
1367 while ($gserver = DBA::fetch($gservers)) {
1368 if (!GServer::check($gserver['url'], $gserver['network'])) {
1369 // The server is not reachable? Okay, then we will try it later
1370 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
1371 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
1375 Logger::info('Update directory', ['server' => $gserver['url'], 'id' => $gserver['id']]);
1376 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
1378 if (--$no_of_queries == 0) {
1383 DBA::close($gservers);
1387 * Discover federated servers
1389 private static function discoverFederation()
1391 $last = DI::config()->get('poco', 'last_federation_discovery');
1394 $next = $last + (24 * 60 * 60);
1396 if ($next > time()) {
1401 // Discover federated servers
1402 $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
1404 if (!empty($curlResult)) {
1405 $servers = json_decode($curlResult, true);
1407 if (!empty($servers['pods'])) {
1408 foreach ($servers['pods'] as $server) {
1409 Worker::add(PRIORITY_LOW, 'UpdateGServer', 'https://' . $server['host']);
1414 // Disvover Mastodon servers
1415 $accesstoken = DI::config()->get('system', 'instances_social_key');
1417 if (!empty($accesstoken)) {
1418 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1419 $header = ['Authorization: Bearer '.$accesstoken];
1420 $curlResult = Network::curl($api, false, ['headers' => $header]);
1422 if ($curlResult->isSuccess()) {
1423 $servers = json_decode($curlResult->getBody(), true);
1425 foreach ($servers['instances'] as $server) {
1426 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
1427 Worker::add(PRIORITY_LOW, 'UpdateGServer', $url);
1432 DI::config()->set('poco', 'last_federation_discovery', time());