4 * @file src/Model/GServer.php
5 * @brief 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;
23 use Friendica\Core\System;
24 use Friendica\Core\Worker;
25 use Friendica\Network\Probe;
26 use Friendica\Protocol\PortableContact;
29 * @brief This class handles GServer related functions
36 * @param string $url Server url
37 * @param boolean $force Force update
39 * @return boolean 'true' if server could be detected
41 public static function detect($url, $force = false)
46 // - Pleroma version number
48 // $gserver = DBA::selectFirst('gserver', [], ['nurl' => Strings::normaliseLink($url)]);
51 // When a nodeinfo is present, we don't need to dig further
52 $xrd_timeout = Config::get('system', 'xrd_timeout');
53 $curlResult = Network::curl($url . '/.well-known/nodeinfo', false, ['timeout' => $xrd_timeout]);
54 if ($curlResult->isTimeout()) {
55 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
59 $nodeinfo = self::fetchNodeinfo($url, $curlResult);
61 if (empty($nodeinfo) || ($nodeinfo['network'] == Protocol::DFRN)) {
62 // Fetch the landing page, possibly it reveals some data
63 $curlResult = Network::curl($url, false, ['timeout' => $xrd_timeout]);
64 if ($curlResult->isSuccess()) {
65 $serverdata = self::analyseRootHeader($curlResult, $serverdata);
66 $serverdata = self::analyseRootBody($curlResult, $serverdata);
69 if (!$curlResult->isSuccess() || empty($curlResult->getBody())) {
70 DBA::update('gserver', ['last_failure' => DateTimeFormat::utcNow()], ['nurl' => Strings::normaliseLink($url)]);
74 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::DFRN)) {
75 $serverdata = self::detectFriendica($url, $serverdata);
78 if (empty($serverdata['network']) || ($serverdata['network'] == Protocol::ACTIVITYPUB)) {
79 $serverdata = self::detectMastodonAlikes($url, $serverdata);
82 // the "siteinfo.json" is some specific endpoint of Hubzilla and Red
83 if (empty($serverdata['network']) || (($serverdata['network'] == Protocol::DIASPORA) && ($serverdata['platform'] != 'diaspora'))) {
84 $serverdata = self::fetchSiteinfo($url, $serverdata);
87 if (empty($serverdata['network'])) {
88 $serverdata = self::detectNextcloud($url, $serverdata);
91 if (empty($serverdata['network'])) {
92 $serverdata = self::detectGNUSocial($url, $serverdata);
95 $serverdata = $nodeinfo;
98 // We can't detect the network type. Possibly it is some system that we don't know yet
99 if (empty($serverdata['network'])) {
100 $serverdata['network'] = Protocol::PHANTOM;
103 $serverdata['url'] = $url;
104 $serverdata['nurl'] = Strings::normaliseLink($url);
106 $fields = array_keys($serverdata);
107 $old_data = DBA::selectFirst('gserver', $fields, ['nurl' => Strings::normaliseLink($url)]);
108 if (!DBA::isResult($old_data)) {
110 $serverdata['created'] = DateTimeFormat::utcNow();
111 DBA::insert('gserver', $serverdata);
113 $serverdata['last_contact'] = DateTimeFormat::utcNow();
114 DBA::update('gserver', $serverdata, ['nurl' => $serverdata['nurl']], $old_data);
121 * @brief Detect server type by using the nodeinfo data
123 * @param string $url address of the server
124 * @return array Server data
125 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
127 private static function fetchNodeinfo($url, $curlResult)
129 $nodeinfo = json_decode($curlResult->getBody(), true);
131 if (!is_array($nodeinfo) || !isset($nodeinfo['links'])) {
138 foreach ($nodeinfo['links'] as $link) {
139 if (!is_array($link) || empty($link['rel']) || empty($link['href'])) {
140 Logger::info('Invalid nodeinfo format', ['url' => $url]);
143 if ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
144 $nodeinfo1_url = $link['href'];
145 } elseif ($link['rel'] == 'http://nodeinfo.diaspora.software/ns/schema/2.0') {
146 $nodeinfo2_url = $link['href'];
150 if ($nodeinfo1_url . $nodeinfo2_url == '') {
156 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
157 if (!empty($nodeinfo2_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo2_url, PHP_URL_HOST))) {
158 $server = self::parseNodeinfo2($nodeinfo2_url);
161 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
162 if (empty($server) && !empty($nodeinfo1_url) && (parse_url($url, PHP_URL_HOST) == parse_url($nodeinfo1_url, PHP_URL_HOST))) {
163 $server = self::parseNodeinfo1($nodeinfo1_url);
170 * @brief Parses Nodeinfo 1
172 * @param string $nodeinfo_url address of the nodeinfo path
173 * @return array Server data
174 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
176 private static function parseNodeinfo1($nodeinfo_url)
178 $curlResult = Network::curl($nodeinfo_url);
180 if (!$curlResult->isSuccess()) {
184 $nodeinfo = json_decode($curlResult->getBody(), true);
186 if (!is_array($nodeinfo)) {
192 $server['register_policy'] = Register::CLOSED;
194 if (!empty($nodeinfo['openRegistrations'])) {
195 $server['register_policy'] = Register::OPEN;
198 if (is_array($nodeinfo['software'])) {
199 if (isset($nodeinfo['software']['name'])) {
200 $server['platform'] = $nodeinfo['software']['name'];
203 if (isset($nodeinfo['software']['version'])) {
204 $server['version'] = $nodeinfo['software']['version'];
205 // Version numbers on Nodeinfo are presented with additional info, e.g.:
206 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
207 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
211 if (isset($nodeinfo['metadata']['nodeName'])) {
212 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
215 if (!empty($nodeinfo['usage']['users']['total'])) {
216 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
219 if (!empty($nodeinfo['protocols']['inbound']) && is_array($nodeinfo['protocols']['inbound'])) {
221 foreach ($nodeinfo['protocols']['inbound'] as $protocol) {
222 $protocols[$protocol] = true;
225 if (!empty($protocols['friendica'])) {
226 $server['network'] = Protocol::DFRN;
227 } elseif (!empty($protocols['activitypub'])) {
228 $server['network'] = Protocol::ACTIVITYPUB;
229 } elseif (!empty($protocols['diaspora'])) {
230 $server['network'] = Protocol::DIASPORA;
231 } elseif (!empty($protocols['ostatus'])) {
232 $server['network'] = Protocol::OSTATUS;
233 } elseif (!empty($protocols['gnusocial'])) {
234 $server['network'] = Protocol::OSTATUS;
249 * @brief Parses Nodeinfo 2
251 * @param string $nodeinfo_url address of the nodeinfo path
252 * @return array Server data
253 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
255 private static function parseNodeinfo2($nodeinfo_url)
257 $curlResult = Network::curl($nodeinfo_url);
258 if (!$curlResult->isSuccess()) {
262 $nodeinfo = json_decode($curlResult->getBody(), true);
264 if (!is_array($nodeinfo)) {
270 $server['register_policy'] = Register::CLOSED;
272 if (!empty($nodeinfo['openRegistrations'])) {
273 $server['register_policy'] = Register::OPEN;
276 if (is_array($nodeinfo['software'])) {
277 if (isset($nodeinfo['software']['name'])) {
278 $server['platform'] = $nodeinfo['software']['name'];
281 if (isset($nodeinfo['software']['version'])) {
282 $server['version'] = $nodeinfo['software']['version'];
283 // Version numbers on Nodeinfo are presented with additional info, e.g.:
284 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
285 $server['version'] = preg_replace('=(.+)-(.{4,})=ism', '$1', $server['version']);
289 if (isset($nodeinfo['metadata']['nodeName'])) {
290 $server['site_name'] = $nodeinfo['metadata']['nodeName'];
293 if (!empty($nodeinfo['usage']['users']['total'])) {
294 $server['registered-users'] = $nodeinfo['usage']['users']['total'];
297 if (!empty($nodeinfo['protocols'])) {
299 foreach ($nodeinfo['protocols'] as $protocol) {
300 $protocols[$protocol] = true;
303 if (!empty($protocols['friendica'])) {
304 $server['network'] = Protocol::DFRN;
305 } elseif (!empty($protocols['activitypub'])) {
306 $server['network'] = Protocol::ACTIVITYPUB;
307 } elseif (!empty($protocols['diaspora'])) {
308 $server['network'] = Protocol::DIASPORA;
309 } elseif (!empty($protocols['ostatus'])) {
310 $server['network'] = Protocol::OSTATUS;
311 } elseif (!empty($protocols['gnusocial'])) {
312 $server['network'] = Protocol::OSTATUS;
319 if (empty($server)) {
326 private static function fetchSiteinfo($url, $serverdata)
328 $curlResult = Network::curl($url . '/siteinfo.json');
329 if (!$curlResult->isSuccess()) {
333 $data = json_decode($curlResult->getBody(), true);
338 if (isset($data['url'])) {
339 $serverdata['platform'] = $data['platform'];
340 $serverdata['version'] = $data['version'];
343 if (!empty($data['plugins'])) {
344 if (in_array('pubcrawl', $data['plugins'])) {
345 $serverdata['network'] = Protocol::ACTIVITYPUB;
346 } elseif (in_array('diaspora', $data['plugins'])) {
347 $serverdata['network'] = Protocol::DIASPORA;
348 } elseif (in_array('gnusoc', $data['plugins'])) {
349 $serverdata['network'] = Protocol::OSTATUS;
351 $serverdata['network'] = Protocol::ZOT;
355 if (!empty($data['site_name'])) {
356 $serverdata['site_name'] = $data['site_name'];
359 if (!empty($data['channels_total'])) {
360 $serverdata['registered-users'] = $data['channels_total'];
363 if (!empty($data['register_policy'])) {
364 switch ($data['register_policy']) {
365 case "REGISTER_OPEN":
366 $serverdata['register_policy'] = Register::OPEN;
369 case "REGISTER_APPROVE":
370 $serverdata['register_policy'] = Register::APPROVE;
373 case "REGISTER_CLOSED":
375 $serverdata['register_policy'] = Register::CLOSED;
383 private static function detectNextcloud($url, $serverdata)
385 $curlResult = Network::curl($url . '/status.php');
387 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
391 $data = json_decode($curlResult->getBody(), true);
396 if (!empty($data['version'])) {
397 $serverdata['platform'] = 'nextcloud';
398 $serverdata['version'] = $data['version'];
399 $serverdata['network'] = Protocol::ACTIVITYPUB;
405 private static function detectMastodonAlikes($url, $serverdata)
407 $curlResult = Network::curl($url . '/api/v1/instance');
409 if (!$curlResult->isSuccess() || ($curlResult->getBody() == '')) {
413 $data = json_decode($curlResult->getBody(), true);
418 if (isset($data['version'])) {
419 $serverdata['platform'] = 'mastodon';
420 $serverdata['version'] = defaults($data, 'version', '');
421 if (!empty($data['title'])) {
422 $serverdata['site_name'] = $data['title'];
424 if (!empty($data['description'])) {
425 $serverdata['info'] = trim($data['description']);
427 $serverdata['network'] = Protocol::ACTIVITYPUB;
430 if (!empty($data['stats']['user_count'])) {
431 $serverdata['registered-users'] = $data['stats']['user_count'];
434 if (strstr($serverdata['version'], 'Pleroma')) {
435 $serverdata['platform'] = 'pleroma';
436 $serverdata['version'] = trim(str_replace('Pleroma', '', $serverdata['version'])); // 2.7.2 (compatible; Pleroma 1.0.0-1225-gf31ad554-develop)
439 if (strstr($serverdata['version'], 'Pixelfed')) {
440 print_r($serverdata);
442 // $serverdata['platform'] = 'pixelfed';
443 // $serverdata['version'] = trim(str_replace('Pixelfed', '', $serverdata['version'])); // 2.7.2 (compatible; Pixelfed 0.10.5)
449 private static function detectGNUSocial($url, $serverdata)
451 $curlResult = Network::curl($url . '/api/statusnet/version.json');
453 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
454 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
455 $serverdata['platform'] = 'StatusNet';
456 // Remove junk that some GNU Social servers return
457 $serverdata['version'] = str_replace(chr(239).chr(187).chr(191), '', $curlResult->getBody());
458 $serverdata['version'] = trim($serverdata['version'], '"');
459 $serverdata['network'] = Protocol::OSTATUS;
462 // Test for GNU Social
463 $curlResult = Network::curl($url . '/api/gnusocial/version.json');
465 if ($curlResult->isSuccess() && ($curlResult->getBody() != '{"error":"not implemented"}') &&
466 ($curlResult->getBody() != '') && (strlen($curlResult->getBody()) < 30)) {
467 $serverdata['platform'] = 'GNU Social';
468 // Remove junk that some GNU Social servers return
469 $serverdata['version'] = str_replace(chr(239) . chr(187) . chr(191), '', $curlResult->getBody());
470 $serverdata['version'] = trim($serverdata['version'], '"');
471 $serverdata['network'] = Protocol::OSTATUS;
477 private static function detectFriendica($url, $serverdata)
479 $curlResult = Network::curl($url . '/friendica/json');
480 if (!$curlResult->isSuccess()) {
481 $curlResult = Network::curl($url . '/friendika/json');
484 if (!$curlResult->isSuccess()) {
488 $data = json_decode($curlResult->getBody(), true);
489 if (empty($data) || empty($data['version'])) {
493 $serverdata['network'] = Protocol::DFRN;
494 $serverdata['version'] = $data['version'];
496 if (!empty($data['no_scrape_url'])) {
497 $serverdata['noscrape'] = $data['no_scrape_url'];
500 if (!empty($data['site_name'])) {
501 $serverdata['site_name'] = $data['site_name'];
504 if (!empty($data['info'])) {
505 $serverdata['info'] = trim($data['info']);
508 $register_policy = defaults($data, 'register_policy', 'REGISTER_CLOSED');
509 switch ($register_policy) {
510 case 'REGISTER_OPEN':
511 $serverdata['register_policy'] = Register::OPEN;
514 case 'REGISTER_APPROVE':
515 $serverdata['register_policy'] = Register::APPROVE;
518 case 'REGISTER_CLOSED':
519 case 'REGISTER_INVITATION':
520 $serverdata['register_policy'] = Register::CLOSED;
523 Logger::info('Register policy is invalid', ['policy' => $register_policy, 'server' => $url]);
524 $serverdata['register_policy'] = Register::CLOSED;
528 $serverdata['platform'] = defaults($data, 'platform', '');
533 private static function analyseRootBody($curlResult, $serverdata)
535 $doc = new DOMDocument();
536 @$doc->loadHTML($curlResult->getBody());
537 $xpath = new DOMXPath($doc);
539 $title = trim(XML::getFirstNodeValue($xpath, '//head/title/text()'));
540 if (!empty($title)) {
541 $serverdata['site_name'] = $title;
544 $list = $xpath->query('//meta[@name]');
546 foreach ($list as $node) {
548 if ($node->attributes->length) {
549 foreach ($node->attributes as $attribute) {
550 $attribute->value = trim($attribute->value);
551 if (empty($attribute->value)) {
555 $attr[$attribute->name] = $attribute->value;
559 if ($attr['name'] == 'description') {
560 $serverdata['info'] = $attr['content'];
563 if ($attr['name'] == 'application-name') {
564 $serverdata['platform'] = $attr['content'];
565 if (in_array($attr['content'], ['Misskey', 'Write.as'])) {
566 $serverdata['network'] = Protocol::ACTIVITYPUB;
570 if (($attr['name'] == 'generator') && in_array($attr['content'], ['Write.as'])) {
572 // $serverdata['platform'] = $attr['content'];
573 // $serverdata['network'] = Protocol::ACTIVITYPUB;
574 } elseif ($attr['name'] == 'generator') {
575 $serverdata['platform'] = $attr['content'];
577 $version_part = explode(' ', $attr['content']);
579 if (count($version_part) == 3) {
580 if (($version_part[0] == 'Red') && ($version_part[1] == 'Matrix')) {
581 // $serverdata['platform'] = $version_part[0] . ' ' . $version_part[1];
582 // $serverdata['version'] = $version_part[2];
583 // $serverdata['network'] = Protocol::DIASPORA;
585 } elseif (count($version_part) == 2) {
586 if (in_array($version_part[0], ['WordPress'])) {
587 $serverdata['platform'] = $version_part[0];
588 $serverdata['version'] = $version_part[1];
589 $serverdata['network'] = Protocol::ACTIVITYPUB;
591 if (in_array($version_part[0], ['Friendika', 'Friendica'])) {
592 $serverdata['platform'] = $version_part[0];
593 $serverdata['version'] = $version_part[1];
594 $serverdata['network'] = Protocol::DFRN;
600 $list = $xpath->query('//meta[@property]');
602 foreach ($list as $node) {
604 if ($node->attributes->length) {
605 foreach ($node->attributes as $attribute) {
606 $attribute->value = trim($attribute->value);
607 if (empty($attribute->value)) {
611 $attr[$attribute->name] = $attribute->value;
616 if ($attr['property'] == 'og:site_name') {
617 $serverdata['site_name'] = $attr['content'];
620 if ($attr['property'] == 'og:description') {
621 $serverdata['info'] = $attr['content'];
624 // if (($attr['property'] == 'og:title') && in_array($attr['content'], ['pixelfed', 'Socialhome'])) {
625 // if (($attr['property'] == 'og:title') && in_array($attr['content'], ['Nextcloud'])) {
626 // $serverdata['platform'] = $attr['content'];
627 // $serverdata['network'] = Protocol::ACTIVITYPUB;
630 if (($attr['property'] == 'og:platform') && in_array($attr['content'], ['PeerTube'])) {
632 // $serverdata['platform'] = $attr['content'];
633 // $serverdata['network'] = Protocol::ACTIVITYPUB;
636 if (($attr['property'] == 'generator') && in_array($attr['content'], ['hubzilla'])) {
637 $serverdata['platform'] = $attr['content'];
638 $serverdata['network'] = Protocol::DIASPORA;
645 private static function analyseRootHeader($curlResult, $serverdata)
647 if ($curlResult->getHeader('server') == 'Mastodon') {
648 $serverdata['platform'] = 'mastodon';
649 $serverdata['network'] = $network = Protocol::ACTIVITYPUB;
650 } elseif ($curlResult->inHeader('x-diaspora-version')) {
651 $serverdata['platform'] = 'diaspora';
652 $serverdata['network'] = $network = Protocol::DIASPORA;
653 $serverdata['version'] = $curlResult->getHeader('x-diaspora-version');
655 } elseif ($curlResult->inHeader('x-friendica-version')) {
656 $serverdata['platform'] = 'friendica';
657 $serverdata['network'] = $network = Protocol::DFRN;
658 $serverdata['version'] = $curlResult->getHeader('x-friendica-version');
661 //print_r($curlResult->getHeaderArray());