3 * @file src/Protocol/PortableContact.php
5 * @todo Move GNU Social URL schemata (http://server.tld/user/number) to http://server.tld/username
6 * @todo Fetch profile data from profile page for Redmatrix users
7 * @todo Detect if it is a forum
10 namespace Friendica\Protocol;
12 use Friendica\Core\Config;
13 use Friendica\Core\Worker;
14 use Friendica\Database\DBM;
15 use Friendica\Model\GContact;
16 use Friendica\Model\Profile;
17 use Friendica\Network\Probe;
23 require_once 'include/dba.php';
24 require_once 'include/datetime.php';
25 require_once 'include/network.php';
26 require_once 'include/html2bbcode.php';
31 * @brief Fetch POCO data
33 * @param integer $cid Contact ID
34 * @param integer $uid User ID
35 * @param integer $zcid Global Contact ID
36 * @param integer $url POCO address that should be polled
38 * Given a contact-id (minimum), load the PortableContacts friend list for that contact,
39 * and add the entries to the gcontact (Global Contact) table, or update existing entries
40 * if anything (name or photo) has changed.
41 * We use normalised urls for comparison which ignore http vs https and www.domain vs domain
43 * Once the global contact is stored add (if necessary) the contact linkage which associates
44 * the given uid, cid to the global contact entry. There can be many uid/cid combinations
45 * pointing to the same global contact id.
48 public static function loadWorker($cid, $uid = 0, $zcid = 0, $url = null)
50 // Call the function "load" via the worker
51 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "load", (int)$cid, (int)$uid, (int)$zcid, $url);
55 * @brief Fetch POCO data from the worker
57 * @param integer $cid Contact ID
58 * @param integer $uid User ID
59 * @param integer $zcid Global Contact ID
60 * @param integer $url POCO address that should be polled
63 public static function load($cid, $uid, $zcid, $url)
69 $r = dba::select('contact', ['poco', 'uid'], ['id' => $cid], ['limit' => 1]);
70 if (DBM::is_result($r)) {
84 $url = $url . (($uid) ? '/@me/@all?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation' : '?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation') ;
86 logger('load: ' . $url, LOGGER_DEBUG);
90 logger('load: returns ' . $s, LOGGER_DATA);
92 logger('load: return code: ' . $a->get_curl_code(), LOGGER_DEBUG);
94 if (($a->get_curl_code() > 299) || (! $s)) {
100 logger('load: json: ' . print_r($j, true), LOGGER_DATA);
102 if (! isset($j->entry)) {
107 foreach ($j->entry as $entry) {
114 $updated = NULL_DATE;
122 $name = $entry->displayName;
124 if (isset($entry->urls)) {
125 foreach ($entry->urls as $url) {
126 if ($url->type == 'profile') {
127 $profile_url = $url->value;
130 if ($url->type == 'webfinger') {
131 $connect_url = str_replace('acct:', '', $url->value);
136 if (isset($entry->photos)) {
137 foreach ($entry->photos as $photo) {
138 if ($photo->type == 'profile') {
139 $profile_photo = $photo->value;
145 if (isset($entry->updated)) {
146 $updated = date("Y-m-d H:i:s", strtotime($entry->updated));
149 if (isset($entry->network)) {
150 $network = $entry->network;
153 if (isset($entry->currentLocation)) {
154 $location = $entry->currentLocation;
157 if (isset($entry->aboutMe)) {
158 $about = html2bbcode($entry->aboutMe);
161 if (isset($entry->gender)) {
162 $gender = $entry->gender;
165 if (isset($entry->generation) && ($entry->generation > 0)) {
166 $generation = ++$entry->generation;
169 if (isset($entry->tags)) {
170 foreach ($entry->tags as $tag) {
171 $keywords = implode(", ", $tag);
175 if (isset($entry->contactType) && ($entry->contactType >= 0)) {
176 $contact_type = $entry->contactType;
179 $gcontact = array("url" => $profile_url,
181 "network" => $network,
182 "photo" => $profile_photo,
184 "location" => $location,
186 "keywords" => $keywords,
187 "connect" => $connect_url,
188 "updated" => $updated,
189 "contact-type" => $contact_type,
190 "generation" => $generation);
193 $gcontact = GContact::sanitize($gcontact);
194 $gcid = GContact::update($gcontact);
196 GContact::link($gcid, $uid, $cid, $zcid);
197 } catch (Exception $e) {
198 logger($e->getMessage(), LOGGER_DEBUG);
201 logger("load: loaded $total entries", LOGGER_DEBUG);
203 $condition = ["`cid` = ? AND `uid` = ? AND `zcid` = ? AND `updated` < UTC_TIMESTAMP - INTERVAL 2 DAY", $cid, $uid, $zcid];
204 dba::delete('glink', $condition);
207 public static function reachable($profile, $server = "", $network = "", $force = false)
210 $server = self::detectServer($profile);
217 return self::checkServer($server, $network, $force);
220 public static function detectServer($profile)
222 // Try to detect the server path based upon some known standard paths
225 if ($server_url == "") {
226 $friendica = preg_replace("=(https?://)(.*)/profile/(.*)=ism", "$1$2", $profile);
227 if ($friendica != $profile) {
228 $server_url = $friendica;
229 $network = NETWORK_DFRN;
233 if ($server_url == "") {
234 $diaspora = preg_replace("=(https?://)(.*)/u/(.*)=ism", "$1$2", $profile);
235 if ($diaspora != $profile) {
236 $server_url = $diaspora;
237 $network = NETWORK_DIASPORA;
241 if ($server_url == "") {
242 $red = preg_replace("=(https?://)(.*)/channel/(.*)=ism", "$1$2", $profile);
243 if ($red != $profile) {
245 $network = NETWORK_DIASPORA;
250 if ($server_url == "") {
251 $mastodon = preg_replace("=(https?://)(.*)/users/(.*)=ism", "$1$2", $profile);
252 if ($mastodon != $profile) {
253 $server_url = $mastodon;
254 $network = NETWORK_OSTATUS;
258 // Numeric OStatus variant
259 if ($server_url == "") {
260 $ostatus = preg_replace("=(https?://)(.*)/user/(.*)=ism", "$1$2", $profile);
261 if ($ostatus != $profile) {
262 $server_url = $ostatus;
263 $network = NETWORK_OSTATUS;
268 if ($server_url == "") {
269 $base = preg_replace("=(https?://)(.*?)/(.*)=ism", "$1$2", $profile);
270 if ($base != $profile) {
272 $network = NETWORK_PHANTOM;
276 if ($server_url == "") {
281 "SELECT `id` FROM `gserver` WHERE `nurl` = '%s' AND `last_contact` > `last_failure`",
282 dbesc(normalise_link($server_url))
285 if (DBM::is_result($r)) {
289 // Fetch the host-meta to check if this really is a server
290 $serverret = z_fetch_url($server_url."/.well-known/host-meta");
291 if (!$serverret["success"]) {
298 public static function alternateOStatusUrl($url)
300 return(preg_match("=https?://.+/user/\d+=ism", $url, $matches));
303 public static function lastUpdated($profile, $force = false)
306 "SELECT * FROM `gcontact` WHERE `nurl` = '%s'",
307 dbesc(normalise_link($profile))
310 if (!DBM::is_result($gcontacts)) {
314 $contact = array("url" => $profile);
316 if ($gcontacts[0]["created"] <= NULL_DATE) {
317 $contact['created'] = datetime_convert();
321 $server_url = normalise_link(self::detectServer($profile));
324 if (($server_url == '') && ($gcontacts[0]["server_url"] != "")) {
325 $server_url = $gcontacts[0]["server_url"];
328 if (!$force && (($server_url == '') || ($gcontacts[0]["server_url"] == $gcontacts[0]["nurl"]))) {
329 $server_url = normalise_link(self::detectServer($profile));
332 if (!in_array($gcontacts[0]["network"], array(NETWORK_DFRN, NETWORK_DIASPORA, NETWORK_FEED, NETWORK_OSTATUS, ""))) {
333 logger("Profile ".$profile.": Network type ".$gcontacts[0]["network"]." can't be checked", LOGGER_DEBUG);
337 if ($server_url != "") {
338 if (!self::checkServer($server_url, $gcontacts[0]["network"], $force)) {
340 $fields = ['last_failure' => datetime_convert()];
341 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
344 logger("Profile ".$profile.": Server ".$server_url." wasn't reachable.", LOGGER_DEBUG);
347 $contact['server_url'] = $server_url;
350 if (in_array($gcontacts[0]["network"], array("", NETWORK_FEED))) {
352 "SELECT `network` FROM `gserver` WHERE `nurl` = '%s' AND `network` != ''",
353 dbesc(normalise_link($server_url))
357 $contact['network'] = $server[0]["network"];
363 // noscrape is really fast so we don't cache the call.
364 if (($server_url != "") && ($gcontacts[0]["nick"] != "")) {
365 // Use noscrape if possible
366 $server = q("SELECT `noscrape`, `network` FROM `gserver` WHERE `nurl` = '%s' AND `noscrape` != ''", dbesc(normalise_link($server_url)));
369 $noscraperet = z_fetch_url($server[0]["noscrape"]."/".$gcontacts[0]["nick"]);
371 if ($noscraperet["success"] && ($noscraperet["body"] != "")) {
372 $noscrape = json_decode($noscraperet["body"], true);
374 if (is_array($noscrape)) {
375 $contact["network"] = $server[0]["network"];
377 if (isset($noscrape["fn"])) {
378 $contact["name"] = $noscrape["fn"];
380 if (isset($noscrape["comm"])) {
381 $contact["community"] = $noscrape["comm"];
383 if (isset($noscrape["tags"])) {
384 $keywords = implode(" ", $noscrape["tags"]);
385 if ($keywords != "") {
386 $contact["keywords"] = $keywords;
390 $location = Profile::formatLocation($noscrape);
392 $contact["location"] = $location;
394 if (isset($noscrape["dfrn-notify"])) {
395 $contact["notify"] = $noscrape["dfrn-notify"];
397 // Remove all fields that are not present in the gcontact table
398 unset($noscrape["fn"]);
399 unset($noscrape["key"]);
400 unset($noscrape["homepage"]);
401 unset($noscrape["comm"]);
402 unset($noscrape["tags"]);
403 unset($noscrape["locality"]);
404 unset($noscrape["region"]);
405 unset($noscrape["country-name"]);
406 unset($noscrape["contacts"]);
407 unset($noscrape["dfrn-request"]);
408 unset($noscrape["dfrn-confirm"]);
409 unset($noscrape["dfrn-notify"]);
410 unset($noscrape["dfrn-poll"]);
412 // Set the date of the last contact
413 /// @todo By now the function "update_gcontact" doesn't work with this field
414 //$contact["last_contact"] = datetime_convert();
416 $contact = array_merge($contact, $noscrape);
418 GContact::update($contact);
420 if (trim($noscrape["updated"]) != "") {
421 $fields = ['last_contact' => datetime_convert()];
422 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
424 logger("Profile ".$profile." was last updated at ".$noscrape["updated"]." (noscrape)", LOGGER_DEBUG);
426 return $noscrape["updated"];
433 // If we only can poll the feed, then we only do this once a while
434 if (!$force && !self::updateNeeded($gcontacts[0]["created"], $gcontacts[0]["updated"], $gcontacts[0]["last_failure"], $gcontacts[0]["last_contact"])) {
435 logger("Profile ".$profile." was last updated at ".$gcontacts[0]["updated"]." (cached)", LOGGER_DEBUG);
437 GContact::update($contact);
438 return $gcontacts[0]["updated"];
441 $data = Probe::uri($profile);
443 // Is the profile link the alternate OStatus link notation? (http://domain.tld/user/4711)
444 // Then check the other link and delete this one
445 if (($data["network"] == NETWORK_OSTATUS) && self::alternateOStatusUrl($profile)
446 && (normalise_link($profile) == normalise_link($data["alias"]))
447 && (normalise_link($profile) != normalise_link($data["url"]))
449 // Delete the old entry
450 dba::delete('gcontact', ['nurl' => normalise_link($profile)]);
452 $gcontact = array_merge($gcontacts[0], $data);
454 $gcontact["server_url"] = $data["baseurl"];
457 $gcontact = GContact::sanitize($gcontact);
458 GContact::update($gcontact);
460 self::lastUpdated($data["url"], $force);
461 } catch (Exception $e) {
462 logger($e->getMessage(), LOGGER_DEBUG);
465 logger("Profile ".$profile." was deleted", LOGGER_DEBUG);
469 if (($data["poll"] == "") || (in_array($data["network"], array(NETWORK_FEED, NETWORK_PHANTOM)))) {
470 $fields = ['last_failure' => datetime_convert()];
471 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
473 logger("Profile ".$profile." wasn't reachable (profile)", LOGGER_DEBUG);
477 $contact = array_merge($contact, $data);
479 $contact["server_url"] = $data["baseurl"];
481 GContact::update($contact);
483 $feedret = z_fetch_url($data["poll"]);
485 if (!$feedret["success"]) {
486 $fields = ['last_failure' => datetime_convert()];
487 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
489 logger("Profile ".$profile." wasn't reachable (no feed)", LOGGER_DEBUG);
493 $doc = new DOMDocument();
494 @$doc->loadXML($feedret["body"]);
496 $xpath = new DOMXPath($doc);
497 $xpath->registerNamespace('atom', "http://www.w3.org/2005/Atom");
499 $entries = $xpath->query('/atom:feed/atom:entry');
503 foreach ($entries as $entry) {
504 $published = $xpath->query('atom:published/text()', $entry)->item(0)->nodeValue;
505 $updated = $xpath->query('atom:updated/text()', $entry)->item(0)->nodeValue;
507 if ($last_updated < $published)
508 $last_updated = $published;
510 if ($last_updated < $updated)
511 $last_updated = $updated;
514 // Maybe there aren't any entries. Then check if it is a valid feed
515 if ($last_updated == "") {
516 if ($xpath->query('/atom:feed')->length > 0) {
517 $last_updated = NULL_DATE;
520 $fields = ['updated' => DBM::date($last_updated), 'last_contact' => DBM::date()];
521 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
523 if (($gcontacts[0]["generation"] == 0)) {
524 $fields = ['generation' => 9];
525 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
528 logger("Profile ".$profile." was last updated at ".$last_updated, LOGGER_DEBUG);
530 return($last_updated);
533 public static function updateNeeded($created, $updated, $last_failure, $last_contact)
535 $now = strtotime(datetime_convert());
537 if ($updated > $last_contact) {
538 $contact_time = strtotime($updated);
540 $contact_time = strtotime($last_contact);
543 $failure_time = strtotime($last_failure);
544 $created_time = strtotime($created);
546 // If there is no "created" time then use the current time
547 if ($created_time <= 0) {
548 $created_time = $now;
551 // If the last contact was less than 24 hours then don't update
552 if (($now - $contact_time) < (60 * 60 * 24)) {
556 // If the last failure was less than 24 hours then don't update
557 if (($now - $failure_time) < (60 * 60 * 24)) {
561 // If the last contact was less than a week ago and the last failure is older than a week then don't update
562 //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
565 // 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
566 if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
570 // 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
571 if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
578 public static function toBoolean($val)
580 if (($val == "true") || ($val == 1)) {
582 } elseif (($val == "false") || ($val == 0)) {
590 * @brief Detect server type (Hubzilla or Friendica) via the poco data
592 * @param object $data POCO data
593 * @return array Server data
595 public static function detectPocoData($data)
599 if (!isset($data->entry)) {
603 if (count($data->entry) == 0) {
607 if (!isset($data->entry[0]->urls)) {
611 if (count($data->entry[0]->urls) == 0) {
615 foreach ($data->entry[0]->urls as $url) {
616 if ($url->type == 'zot') {
618 $server["platform"] = 'Hubzilla';
619 $server["network"] = NETWORK_DIASPORA;
627 * @brief Detect server type by using the nodeinfo data
629 * @param string $server_url address of the server
630 * @return array Server data
632 public static function fetchNodeinfo($server_url)
634 $serverret = z_fetch_url($server_url."/.well-known/nodeinfo");
635 if (!$serverret["success"]) {
639 $nodeinfo = json_decode($serverret['body']);
641 if (!is_object($nodeinfo)) {
645 if (!is_array($nodeinfo->links)) {
651 foreach ($nodeinfo->links as $link) {
652 if ($link->rel == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
653 $nodeinfo_url = $link->href;
657 if ($nodeinfo_url == '') {
661 $serverret = z_fetch_url($nodeinfo_url);
662 if (!$serverret["success"]) {
666 $nodeinfo = json_decode($serverret['body']);
668 if (!is_object($nodeinfo)) {
674 $server['register_policy'] = REGISTER_CLOSED;
676 if (is_bool($nodeinfo->openRegistrations) && $nodeinfo->openRegistrations) {
677 $server['register_policy'] = REGISTER_OPEN;
680 if (is_object($nodeinfo->software)) {
681 if (isset($nodeinfo->software->name)) {
682 $server['platform'] = $nodeinfo->software->name;
685 if (isset($nodeinfo->software->version)) {
686 $server['version'] = $nodeinfo->software->version;
687 // Version numbers on Nodeinfo are presented with additional info, e.g.:
688 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
689 $server['version'] = preg_replace("=(.+)-(.{4,})=ism", "$1", $server['version']);
693 if (is_object($nodeinfo->metadata)) {
694 if (isset($nodeinfo->metadata->nodeName)) {
695 $server['site_name'] = $nodeinfo->metadata->nodeName;
699 if (!empty($nodeinfo->usage->users->total)) {
700 $server['registered-users'] = $nodeinfo->usage->users->total;
707 if (is_array($nodeinfo->protocols->inbound)) {
708 foreach ($nodeinfo->protocols->inbound as $inbound) {
709 if ($inbound == 'diaspora') {
712 if ($inbound == 'friendica') {
715 if ($inbound == 'gnusocial') {
722 $server['network'] = NETWORK_OSTATUS;
725 $server['network'] = NETWORK_DIASPORA;
728 $server['network'] = NETWORK_DFRN;
739 * @brief Detect server type (Hubzilla or Friendica) via the front page body
741 * @param string $body Front page of the server
742 * @return array Server data
744 public static function detectServerType($body)
748 $doc = new DOMDocument();
749 @$doc->loadHTML($body);
750 $xpath = new DOMXPath($doc);
752 $list = $xpath->query("//meta[@name]");
754 foreach ($list as $node) {
756 if ($node->attributes->length) {
757 foreach ($node->attributes as $attribute) {
758 $attr[$attribute->name] = $attribute->value;
761 if ($attr['name'] == 'generator') {
762 $version_part = explode(" ", $attr['content']);
763 if (count($version_part) == 2) {
764 if (in_array($version_part[0], array("Friendika", "Friendica"))) {
766 $server["platform"] = $version_part[0];
767 $server["version"] = $version_part[1];
768 $server["network"] = NETWORK_DFRN;
775 $list = $xpath->query("//meta[@property]");
777 foreach ($list as $node) {
779 if ($node->attributes->length) {
780 foreach ($node->attributes as $attribute) {
781 $attr[$attribute->name] = $attribute->value;
784 if ($attr['property'] == 'generator' && in_array($attr['content'], array("hubzilla", "BlaBlaNet"))) {
786 $server["platform"] = $attr['content'];
787 $server["version"] = "";
788 $server["network"] = NETWORK_DIASPORA;
797 $server["site_name"] = $xpath->evaluate("//head/title/text()")->item(0)->nodeValue;
801 public static function checkServer($server_url, $network = "", $force = false)
803 // Unify the server address
804 $server_url = trim($server_url, "/");
805 $server_url = str_replace("/index.php", "", $server_url);
807 if ($server_url == "") {
811 $servers = dba::select('gserver', [], ['nurl' => normalise_link($server_url)], ['limit' => 1]);
812 if (DBM::is_result($servers)) {
813 if ($servers["created"] <= NULL_DATE) {
814 $fields = ['created' => datetime_convert()];
815 $condition = ['nurl' => normalise_link($server_url)];
816 dba::update('gserver', $fields, $condition);
818 $poco = $servers["poco"];
819 $noscrape = $servers["noscrape"];
821 if ($network == "") {
822 $network = $servers["network"];
825 $last_contact = $servers["last_contact"];
826 $last_failure = $servers["last_failure"];
827 $version = $servers["version"];
828 $platform = $servers["platform"];
829 $site_name = $servers["site_name"];
830 $info = $servers["info"];
831 $register_policy = $servers["register_policy"];
832 $registered_users = $servers["registered-users"];
834 if (!$force && !self::updateNeeded($servers["created"], "", $last_failure, $last_contact)) {
835 logger("Use cached data for server ".$server_url, LOGGER_DEBUG);
836 return ($last_contact >= $last_failure);
845 $register_policy = -1;
846 $registered_users = 0;
848 $last_contact = NULL_DATE;
849 $last_failure = NULL_DATE;
851 logger("Server ".$server_url." is outdated or unknown. Start discovery. Force: ".$force." Created: ".$servers["created"]." Failure: ".$last_failure." Contact: ".$last_contact, LOGGER_DEBUG);
854 $possible_failure = false;
855 $orig_last_failure = $last_failure;
856 $orig_last_contact = $last_contact;
858 // Check if the page is accessible via SSL.
859 $orig_server_url = $server_url;
860 $server_url = str_replace("http://", "https://", $server_url);
862 // We set the timeout to 20 seconds since this operation should be done in no time if the server was vital
863 $serverret = z_fetch_url($server_url."/.well-known/host-meta", false, $redirects, array('timeout' => 20));
865 // Quit if there is a timeout.
866 // But we want to make sure to only quit if we are mostly sure that this server url fits.
867 if (DBM::is_result($servers) && ($orig_server_url == $server_url) &&
868 ($serverret['errno'] == CURLE_OPERATION_TIMEDOUT)) {
869 logger("Connection to server ".$server_url." timed out.", LOGGER_DEBUG);
870 dba::update('gserver', array('last_failure' => datetime_convert()), array('nurl' => normalise_link($server_url)));
874 // Maybe the page is unencrypted only?
875 $xmlobj = @simplexml_load_string($serverret["body"], 'SimpleXMLElement', 0, "http://docs.oasis-open.org/ns/xri/xrd-1.0");
876 if (!$serverret["success"] || ($serverret["body"] == "") || (@sizeof($xmlobj) == 0) || !is_object($xmlobj)) {
877 $server_url = str_replace("https://", "http://", $server_url);
879 // We set the timeout to 20 seconds since this operation should be done in no time if the server was vital
880 $serverret = z_fetch_url($server_url."/.well-known/host-meta", false, $redirects, array('timeout' => 20));
882 // Quit if there is a timeout
883 if ($serverret['errno'] == CURLE_OPERATION_TIMEDOUT) {
884 logger("Connection to server ".$server_url." timed out.", LOGGER_DEBUG);
885 dba::update('gserver', array('last_failure' => datetime_convert()), array('nurl' => normalise_link($server_url)));
889 $xmlobj = @simplexml_load_string($serverret["body"], 'SimpleXMLElement', 0, "http://docs.oasis-open.org/ns/xri/xrd-1.0");
892 if (!$serverret["success"] || ($serverret["body"] == "") || (sizeof($xmlobj) == 0) || !is_object($xmlobj)) {
893 // Workaround for bad configured servers (known nginx problem)
894 if (!in_array($serverret["debug"]["http_code"], array("403", "404"))) {
897 $possible_failure = true;
900 // If the server has no possible failure we reset the cached data
901 if (!$possible_failure) {
906 $register_policy = -1;
910 // This will be too low, but better than no value at all.
911 $registered_users = dba::count('gcontact', ['server_url' => normalise_link($server_url)]);
913 // Every server has got an admin account at least
914 if ($registered_users == 0) {
915 $registered_users = 1;
921 $serverret = z_fetch_url($server_url."/poco");
922 if ($serverret["success"]) {
923 $data = json_decode($serverret["body"]);
924 if (isset($data->totalResults)) {
925 $registered_users = $data->totalResults;
926 $poco = $server_url."/poco";
927 $server = self::detectPocoData($data);
929 $platform = $server['platform'];
930 $network = $server['network'];
939 // Test for Diaspora, Hubzilla, Mastodon or older Friendica servers
940 $serverret = z_fetch_url($server_url);
942 if (!$serverret["success"] || ($serverret["body"] == "")) {
945 $server = self::detectServerType($serverret["body"]);
947 $platform = $server['platform'];
948 $network = $server['network'];
949 $version = $server['version'];
950 $site_name = $server['site_name'];
953 $lines = explode("\n", $serverret["header"]);
955 foreach ($lines as $line) {
957 if (stristr($line, 'X-Diaspora-Version:')) {
958 $platform = "Diaspora";
959 $version = trim(str_replace("X-Diaspora-Version:", "", $line));
960 $version = trim(str_replace("x-diaspora-version:", "", $version));
961 $network = NETWORK_DIASPORA;
962 $versionparts = explode("-", $version);
963 $version = $versionparts[0];
966 if (stristr($line, 'Server: Mastodon')) {
967 $platform = "Mastodon";
968 $network = NETWORK_OSTATUS;
975 if (!$failure && ($poco == "")) {
976 // Test for Statusnet
977 // Will also return data for Friendica and GNU Social - but it will be overwritten later
978 // The "not implemented" is a special treatment for really, really old Friendica versions
979 $serverret = z_fetch_url($server_url."/api/statusnet/version.json");
980 if ($serverret["success"] && ($serverret["body"] != '{"error":"not implemented"}') &&
981 ($serverret["body"] != '') && (strlen($serverret["body"]) < 30)) {
982 $platform = "StatusNet";
983 // Remove junk that some GNU Social servers return
984 $version = str_replace(chr(239).chr(187).chr(191), "", $serverret["body"]);
985 $version = trim($version, '"');
986 $network = NETWORK_OSTATUS;
989 // Test for GNU Social
990 $serverret = z_fetch_url($server_url."/api/gnusocial/version.json");
991 if ($serverret["success"] && ($serverret["body"] != '{"error":"not implemented"}') &&
992 ($serverret["body"] != '') && (strlen($serverret["body"]) < 30)) {
993 $platform = "GNU Social";
994 // Remove junk that some GNU Social servers return
995 $version = str_replace(chr(239).chr(187).chr(191), "", $serverret["body"]);
996 $version = trim($version, '"');
997 $network = NETWORK_OSTATUS;
1000 // Test for Mastodon
1001 $orig_version = $version;
1002 $serverret = z_fetch_url($server_url."/api/v1/instance");
1003 if ($serverret["success"] && ($serverret["body"] != '')) {
1004 $data = json_decode($serverret["body"]);
1005 if (isset($data->version)) {
1006 $platform = "Mastodon";
1007 $version = $data->version;
1008 $site_name = $data->title;
1009 $info = $data->description;
1010 $network = NETWORK_OSTATUS;
1012 if (!empty($data->stats->user_count)) {
1013 $registered_users = $data->stats->user_count;
1016 if (strstr($orig_version.$version, 'Pleroma')) {
1017 $platform = 'Pleroma';
1018 $version = trim(str_replace('Pleroma', '', $version));
1023 // Test for Hubzilla and Red
1024 $serverret = z_fetch_url($server_url."/siteinfo.json");
1025 if ($serverret["success"]) {
1026 $data = json_decode($serverret["body"]);
1027 if (isset($data->url)) {
1028 $platform = $data->platform;
1029 $version = $data->version;
1030 $network = NETWORK_DIASPORA;
1032 if (!empty($data->site_name)) {
1033 $site_name = $data->site_name;
1035 if (!empty($data->channels_total)) {
1036 $registered_users = $data->channels_total;
1038 switch ($data->register_policy) {
1039 case "REGISTER_OPEN":
1040 $register_policy = REGISTER_OPEN;
1042 case "REGISTER_APPROVE":
1043 $register_policy = REGISTER_APPROVE;
1045 case "REGISTER_CLOSED":
1047 $register_policy = REGISTER_CLOSED;
1051 // Test for Hubzilla, Redmatrix or Friendica
1052 $serverret = z_fetch_url($server_url."/api/statusnet/config.json");
1053 if ($serverret["success"]) {
1054 $data = json_decode($serverret["body"]);
1055 if (isset($data->site->server)) {
1056 if (isset($data->site->platform)) {
1057 $platform = $data->site->platform->PLATFORM_NAME;
1058 $version = $data->site->platform->STD_VERSION;
1059 $network = NETWORK_DIASPORA;
1061 if (isset($data->site->BlaBlaNet)) {
1062 $platform = $data->site->BlaBlaNet->PLATFORM_NAME;
1063 $version = $data->site->BlaBlaNet->STD_VERSION;
1064 $network = NETWORK_DIASPORA;
1066 if (isset($data->site->hubzilla)) {
1067 $platform = $data->site->hubzilla->PLATFORM_NAME;
1068 $version = $data->site->hubzilla->RED_VERSION;
1069 $network = NETWORK_DIASPORA;
1071 if (isset($data->site->redmatrix)) {
1072 if (isset($data->site->redmatrix->PLATFORM_NAME)) {
1073 $platform = $data->site->redmatrix->PLATFORM_NAME;
1074 } elseif (isset($data->site->redmatrix->RED_PLATFORM)) {
1075 $platform = $data->site->redmatrix->RED_PLATFORM;
1078 $version = $data->site->redmatrix->RED_VERSION;
1079 $network = NETWORK_DIASPORA;
1081 if (isset($data->site->friendica)) {
1082 $platform = $data->site->friendica->FRIENDICA_PLATFORM;
1083 $version = $data->site->friendica->FRIENDICA_VERSION;
1084 $network = NETWORK_DFRN;
1087 $site_name = $data->site->name;
1089 $data->site->closed = self::toBoolean($data->site->closed);
1090 $data->site->private = self::toBoolean($data->site->private);
1091 $data->site->inviteonly = self::toBoolean($data->site->inviteonly);
1093 if (!$data->site->closed && !$data->site->private and $data->site->inviteonly) {
1094 $register_policy = REGISTER_APPROVE;
1095 } elseif (!$data->site->closed && !$data->site->private) {
1096 $register_policy = REGISTER_OPEN;
1098 $register_policy = REGISTER_CLOSED;
1105 // Query statistics.json. Optional package for Diaspora, Friendica and Redmatrix
1107 $serverret = z_fetch_url($server_url."/statistics.json");
1108 if ($serverret["success"]) {
1109 $data = json_decode($serverret["body"]);
1110 if (isset($data->version)) {
1111 $version = $data->version;
1112 // Version numbers on statistics.json are presented with additional info, e.g.:
1113 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
1114 $version = preg_replace("=(.+)-(.{4,})=ism", "$1", $version);
1117 if (!empty($data->name)) {
1118 $site_name = $data->name;
1121 if (!empty($data->network)) {
1122 $platform = $data->network;
1125 if ($platform == "Diaspora") {
1126 $network = NETWORK_DIASPORA;
1129 if ($data->registrations_open) {
1130 $register_policy = REGISTER_OPEN;
1132 $register_policy = REGISTER_CLOSED;
1137 // Query nodeinfo. Working for (at least) Diaspora and Friendica.
1139 $server = self::fetchNodeinfo($server_url);
1141 $register_policy = $server['register_policy'];
1143 if (isset($server['platform'])) {
1144 $platform = $server['platform'];
1147 if (isset($server['network'])) {
1148 $network = $server['network'];
1151 if (isset($server['version'])) {
1152 $version = $server['version'];
1155 if (isset($server['site_name'])) {
1156 $site_name = $server['site_name'];
1159 if (isset($server['registered-users'])) {
1160 $registered_users = $server['registered-users'];
1165 // Check for noscrape
1166 // Friendica servers could be detected as OStatus servers
1167 if (!$failure && in_array($network, array(NETWORK_DFRN, NETWORK_OSTATUS))) {
1168 $serverret = z_fetch_url($server_url."/friendica/json");
1170 if (!$serverret["success"]) {
1171 $serverret = z_fetch_url($server_url."/friendika/json");
1174 if ($serverret["success"]) {
1175 $data = json_decode($serverret["body"]);
1177 if (isset($data->version)) {
1178 $network = NETWORK_DFRN;
1180 $noscrape = $data->no_scrape_url;
1181 $version = $data->version;
1182 $site_name = $data->site_name;
1183 $info = $data->info;
1184 $register_policy_str = $data->register_policy;
1185 $platform = $data->platform;
1187 switch ($register_policy_str) {
1188 case "REGISTER_CLOSED":
1189 $register_policy = REGISTER_CLOSED;
1191 case "REGISTER_APPROVE":
1192 $register_policy = REGISTER_APPROVE;
1194 case "REGISTER_OPEN":
1195 $register_policy = REGISTER_OPEN;
1202 if ($possible_failure && !$failure) {
1207 $last_contact = $orig_last_contact;
1208 $last_failure = datetime_convert();
1210 $last_contact = datetime_convert();
1211 $last_failure = $orig_last_failure;
1214 if (($last_contact <= $last_failure) && !$failure) {
1215 logger("Server ".$server_url." seems to be alive, but last contact wasn't set - could be a bug", LOGGER_DEBUG);
1216 } elseif (($last_contact >= $last_failure) && $failure) {
1217 logger("Server ".$server_url." seems to be dead, but last failure wasn't set - could be a bug", LOGGER_DEBUG);
1220 // Check again if the server exists
1221 $found = dba::exists('gserver', array('nurl' => normalise_link($server_url)));
1223 $version = strip_tags($version);
1224 $site_name = strip_tags($site_name);
1225 $info = strip_tags($info);
1226 $platform = strip_tags($platform);
1228 $fields = ['url' => $server_url, 'version' => $version,
1229 'site_name' => $site_name, 'info' => $info, 'register_policy' => $register_policy,
1230 'poco' => $poco, 'noscrape' => $noscrape, 'network' => $network,
1231 'platform' => $platform, 'registered-users' => $registered_users,
1232 'last_contact' => $last_contact, 'last_failure' => last_failure];
1235 dba::update('gserver', $fields, ['nurl' => normalise_link($server_url)]);
1236 } elseif (!$failure) {
1237 $fields['nurl'] = normalise_link($server_url);
1238 $fields['created'] = datetime_convert();
1239 dba::insert('gserver', $fields);
1241 logger("End discovery for server " . $server_url, LOGGER_DEBUG);
1247 * @brief Returns a list of all known servers
1248 * @return array List of server urls
1250 public static function serverlist()
1253 "SELECT `url`, `site_name` AS `displayName`, `network`, `platform`, `version` FROM `gserver`
1254 WHERE `network` IN ('%s', '%s', '%s') AND `last_contact` > `last_failure`
1255 ORDER BY `last_contact`
1257 dbesc(NETWORK_DFRN),
1258 dbesc(NETWORK_DIASPORA),
1259 dbesc(NETWORK_OSTATUS)
1262 if (!DBM::is_result($r)) {
1270 * @brief Fetch server list from remote servers and adds them when they are new.
1272 * @param string $poco URL to the POCO endpoint
1274 public static function fetchServerlist($poco)
1276 $serverret = z_fetch_url($poco."/@server");
1277 if (!$serverret["success"]) {
1280 $serverlist = json_decode($serverret['body']);
1282 if (!is_array($serverlist)) {
1286 foreach ($serverlist as $server) {
1287 $server_url = str_replace("/index.php", "", $server->url);
1289 $r = q("SELECT `nurl` FROM `gserver` WHERE `nurl` = '%s'", dbesc(normalise_link($server_url)));
1290 if (!DBM::is_result($r)) {
1291 logger("Call server check for server ".$server_url, LOGGER_DEBUG);
1292 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", $server_url);
1297 public static function discoverFederation()
1299 $last = Config::get('poco', 'last_federation_discovery');
1302 $next = $last + (24 * 60 * 60);
1303 if ($next > time()) {
1308 // Discover Friendica, Hubzilla and Diaspora servers
1309 $serverdata = fetch_url("http://the-federation.info/pods.json");
1312 $servers = json_decode($serverdata);
1314 foreach ($servers->pods as $server) {
1315 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", "https://".$server->host);
1319 // Disvover Mastodon servers
1320 if (!Config::get('system', 'ostatus_disabled')) {
1321 $accesstoken = Config::get('system', 'instances_social_key');
1322 if (!empty($accesstoken)) {
1323 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1324 $header = array('Authorization: Bearer '.$accesstoken);
1325 $serverdata = z_fetch_url($api, false, $redirects, ['headers' => $header]);
1326 if ($serverdata['success']) {
1327 $servers = json_decode($serverdata['body']);
1328 foreach ($servers->instances as $server) {
1329 $url = (is_null($server->https_score) ? 'http' : 'https').'://'.$server->name;
1330 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", $url);
1336 // Currently disabled, since the service isn't available anymore.
1337 // It is not removed since I hope that there will be a successor.
1338 // Discover GNU Social Servers.
1339 //if (!Config::get('system','ostatus_disabled')) {
1340 // $serverdata = "http://gstools.org/api/get_open_instances/";
1342 // $result = z_fetch_url($serverdata);
1343 // if ($result["success"]) {
1344 // $servers = json_decode($result["body"]);
1346 // foreach($servers->data as $server)
1347 // self::checkServer($server->instance_address);
1351 Config::set('poco', 'last_federation_discovery', time());
1354 public static function discoverSingleServer($id)
1356 $r = q("SELECT `poco`, `nurl`, `url`, `network` FROM `gserver` WHERE `id` = %d", intval($id));
1357 if (!DBM::is_result($r)) {
1363 // Discover new servers out there (Works from Friendica version 3.5.2)
1364 self::fetchServerlist($server["poco"]);
1366 // Fetch all users from the other server
1367 $url = $server["poco"]."/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
1369 logger("Fetch all users from the server ".$server["url"], LOGGER_DEBUG);
1371 $retdata = z_fetch_url($url);
1372 if ($retdata["success"]) {
1373 $data = json_decode($retdata["body"]);
1375 self::discoverServer($data, 2);
1377 if (Config::get('system', 'poco_discovery') > 1) {
1378 $timeframe = Config::get('system', 'poco_discovery_since');
1379 if ($timeframe == 0) {
1383 $updatedSince = date("Y-m-d H:i:s", time() - $timeframe * 86400);
1385 // Fetch all global contacts from the other server (Not working with Redmatrix and Friendica versions before 3.3)
1386 $url = $server["poco"]."/@global?updatedSince=".$updatedSince."&fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
1390 $retdata = z_fetch_url($url);
1391 if ($retdata["success"]) {
1392 logger("Fetch all global contacts from the server ".$server["nurl"], LOGGER_DEBUG);
1393 $success = self::discoverServer(json_decode($retdata["body"]));
1396 if (!$success && (Config::get('system', 'poco_discovery') > 2)) {
1397 logger("Fetch contacts from users of the server ".$server["nurl"], LOGGER_DEBUG);
1398 self::discoverServerUsers($data, $server);
1402 $fields = ['last_poco_query' => datetime_convert()];
1403 dba::update('gserver', $fields, ['nurl' => $server["nurl"]]);
1407 // If the server hadn't replied correctly, then force a sanity check
1408 self::checkServer($server["url"], $server["network"], true);
1410 // If we couldn't reach the server, we will try it some time later
1411 $fields = ['last_poco_query' => datetime_convert()];
1412 dba::update('gserver', $fields, ['nurl' => $server["nurl"]]);
1418 public static function discover($complete = false)
1420 // Update the server list
1421 self::discoverFederation();
1425 $requery_days = intval(Config::get("system", "poco_requery_days"));
1427 if ($requery_days == 0) {
1430 $last_update = date("c", time() - (60 * 60 * 24 * $requery_days));
1432 $r = q("SELECT `id`, `url`, `network` FROM `gserver` WHERE `last_contact` >= `last_failure` AND `poco` != '' AND `last_poco_query` < '%s' ORDER BY RAND()", dbesc($last_update));
1433 if (DBM::is_result($r)) {
1434 foreach ($r as $server) {
1435 if (!self::checkServer($server["url"], $server["network"])) {
1436 // The server is not reachable? Okay, then we will try it later
1437 $fields = ['last_poco_query' => datetime_convert()];
1438 dba::update('gserver', $fields, ['nurl' => $server["nurl"]]);
1442 logger('Update directory from server '.$server['url'].' with ID '.$server['id'], LOGGER_DEBUG);
1443 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "update_server_directory", (int)$server['id']);
1445 if (!$complete && (--$no_of_queries == 0)) {
1452 public static function discoverServerUsers($data, $server)
1454 if (!isset($data->entry)) {
1458 foreach ($data->entry as $entry) {
1460 if (isset($entry->urls)) {
1461 foreach ($entry->urls as $url) {
1462 if ($url->type == 'profile') {
1463 $profile_url = $url->value;
1464 $urlparts = parse_url($profile_url);
1465 $username = end(explode("/", $urlparts["path"]));
1469 if ($username != "") {
1470 logger("Fetch contacts for the user ".$username." from the server ".$server["nurl"], LOGGER_DEBUG);
1472 // Fetch all contacts from a given user from the other server
1473 $url = $server["poco"]."/".$username."/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
1475 $retdata = z_fetch_url($url);
1476 if ($retdata["success"]) {
1477 self::discoverServer(json_decode($retdata["body"]), 3);
1483 public static function discoverServer($data, $default_generation = 0)
1485 if (!isset($data->entry) || !count($data->entry)) {
1491 foreach ($data->entry as $entry) {
1493 $profile_photo = '';
1497 $updated = NULL_DATE;
1503 $generation = $default_generation;
1505 $name = $entry->displayName;
1507 if (isset($entry->urls)) {
1508 foreach ($entry->urls as $url) {
1509 if ($url->type == 'profile') {
1510 $profile_url = $url->value;
1513 if ($url->type == 'webfinger') {
1514 $connect_url = str_replace('acct:' , '', $url->value);
1520 if (isset($entry->photos)) {
1521 foreach ($entry->photos as $photo) {
1522 if ($photo->type == 'profile') {
1523 $profile_photo = $photo->value;
1529 if (isset($entry->updated)) {
1530 $updated = date("Y-m-d H:i:s", strtotime($entry->updated));
1533 if (isset($entry->network)) {
1534 $network = $entry->network;
1537 if (isset($entry->currentLocation)) {
1538 $location = $entry->currentLocation;
1541 if (isset($entry->aboutMe)) {
1542 $about = html2bbcode($entry->aboutMe);
1545 if (isset($entry->gender)) {
1546 $gender = $entry->gender;
1549 if (isset($entry->generation) && ($entry->generation > 0)) {
1550 $generation = ++$entry->generation;
1553 if (isset($entry->contactType) && ($entry->contactType >= 0)) {
1554 $contact_type = $entry->contactType;
1557 if (isset($entry->tags)) {
1558 foreach ($entry->tags as $tag) {
1559 $keywords = implode(", ", $tag);
1563 if ($generation > 0) {
1566 logger("Store profile ".$profile_url, LOGGER_DEBUG);
1568 $gcontact = array("url" => $profile_url,
1570 "network" => $network,
1571 "photo" => $profile_photo,
1573 "location" => $location,
1574 "gender" => $gender,
1575 "keywords" => $keywords,
1576 "connect" => $connect_url,
1577 "updated" => $updated,
1578 "contact-type" => $contact_type,
1579 "generation" => $generation);
1582 $gcontact = GContact::sanitize($gcontact);
1583 GContact::update($gcontact);
1584 } catch (Exception $e) {
1585 logger($e->getMessage(), LOGGER_DEBUG);
1588 logger("Done for profile ".$profile_url, LOGGER_DEBUG);