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;
18 use Friendica\Util\Network;
24 require_once 'include/dba.php';
25 require_once 'include/datetime.php';
26 require_once 'include/network.php';
27 require_once 'include/html2bbcode.php';
32 * @brief Fetch POCO data
34 * @param integer $cid Contact ID
35 * @param integer $uid User ID
36 * @param integer $zcid Global Contact ID
37 * @param integer $url POCO address that should be polled
39 * Given a contact-id (minimum), load the PortableContacts friend list for that contact,
40 * and add the entries to the gcontact (Global Contact) table, or update existing entries
41 * if anything (name or photo) has changed.
42 * We use normalised urls for comparison which ignore http vs https and www.domain vs domain
44 * Once the global contact is stored add (if necessary) the contact linkage which associates
45 * the given uid, cid to the global contact entry. There can be many uid/cid combinations
46 * pointing to the same global contact id.
49 public static function loadWorker($cid, $uid = 0, $zcid = 0, $url = null)
51 // Call the function "load" via the worker
52 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "load", (int)$cid, (int)$uid, (int)$zcid, $url);
56 * @brief Fetch POCO data from the worker
58 * @param integer $cid Contact ID
59 * @param integer $uid User ID
60 * @param integer $zcid Global Contact ID
61 * @param integer $url POCO address that should be polled
64 public static function load($cid, $uid, $zcid, $url)
70 $contact = dba::selectFirst('contact', ['poco', 'uid'], ['id' => $cid]);
71 if (DBM::is_result($contact)) {
72 $url = $contact['poco'];
73 $uid = $contact['uid'];
85 $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') ;
87 logger('load: ' . $url, LOGGER_DEBUG);
89 $s = Network::fetchURL($url);
91 logger('load: returns ' . $s, LOGGER_DATA);
93 logger('load: return code: ' . $a->get_curl_code(), LOGGER_DEBUG);
95 if (($a->get_curl_code() > 299) || (! $s)) {
101 logger('load: json: ' . print_r($j, true), LOGGER_DATA);
103 if (! isset($j->entry)) {
108 foreach ($j->entry as $entry) {
115 $updated = NULL_DATE;
123 $name = $entry->displayName;
125 if (isset($entry->urls)) {
126 foreach ($entry->urls as $url) {
127 if ($url->type == 'profile') {
128 $profile_url = $url->value;
131 if ($url->type == 'webfinger') {
132 $connect_url = str_replace('acct:', '', $url->value);
137 if (isset($entry->photos)) {
138 foreach ($entry->photos as $photo) {
139 if ($photo->type == 'profile') {
140 $profile_photo = $photo->value;
146 if (isset($entry->updated)) {
147 $updated = date("Y-m-d H:i:s", strtotime($entry->updated));
150 if (isset($entry->network)) {
151 $network = $entry->network;
154 if (isset($entry->currentLocation)) {
155 $location = $entry->currentLocation;
158 if (isset($entry->aboutMe)) {
159 $about = html2bbcode($entry->aboutMe);
162 if (isset($entry->gender)) {
163 $gender = $entry->gender;
166 if (isset($entry->generation) && ($entry->generation > 0)) {
167 $generation = ++$entry->generation;
170 if (isset($entry->tags)) {
171 foreach ($entry->tags as $tag) {
172 $keywords = implode(", ", $tag);
176 if (isset($entry->contactType) && ($entry->contactType >= 0)) {
177 $contact_type = $entry->contactType;
180 $gcontact = ["url" => $profile_url,
182 "network" => $network,
183 "photo" => $profile_photo,
185 "location" => $location,
187 "keywords" => $keywords,
188 "connect" => $connect_url,
189 "updated" => $updated,
190 "contact-type" => $contact_type,
191 "generation" => $generation];
194 $gcontact = GContact::sanitize($gcontact);
195 $gcid = GContact::update($gcontact);
197 GContact::link($gcid, $uid, $cid, $zcid);
198 } catch (Exception $e) {
199 logger($e->getMessage(), LOGGER_DEBUG);
202 logger("load: loaded $total entries", LOGGER_DEBUG);
204 $condition = ["`cid` = ? AND `uid` = ? AND `zcid` = ? AND `updated` < UTC_TIMESTAMP - INTERVAL 2 DAY", $cid, $uid, $zcid];
205 dba::delete('glink', $condition);
208 public static function reachable($profile, $server = "", $network = "", $force = false)
211 $server = self::detectServer($profile);
218 return self::checkServer($server, $network, $force);
221 public static function detectServer($profile)
223 // Try to detect the server path based upon some known standard paths
226 if ($server_url == "") {
227 $friendica = preg_replace("=(https?://)(.*)/profile/(.*)=ism", "$1$2", $profile);
228 if ($friendica != $profile) {
229 $server_url = $friendica;
230 $network = NETWORK_DFRN;
234 if ($server_url == "") {
235 $diaspora = preg_replace("=(https?://)(.*)/u/(.*)=ism", "$1$2", $profile);
236 if ($diaspora != $profile) {
237 $server_url = $diaspora;
238 $network = NETWORK_DIASPORA;
242 if ($server_url == "") {
243 $red = preg_replace("=(https?://)(.*)/channel/(.*)=ism", "$1$2", $profile);
244 if ($red != $profile) {
246 $network = NETWORK_DIASPORA;
251 if ($server_url == "") {
252 $mastodon = preg_replace("=(https?://)(.*)/users/(.*)=ism", "$1$2", $profile);
253 if ($mastodon != $profile) {
254 $server_url = $mastodon;
255 $network = NETWORK_OSTATUS;
259 // Numeric OStatus variant
260 if ($server_url == "") {
261 $ostatus = preg_replace("=(https?://)(.*)/user/(.*)=ism", "$1$2", $profile);
262 if ($ostatus != $profile) {
263 $server_url = $ostatus;
264 $network = NETWORK_OSTATUS;
269 if ($server_url == "") {
270 $base = preg_replace("=(https?://)(.*?)/(.*)=ism", "$1$2", $profile);
271 if ($base != $profile) {
273 $network = NETWORK_PHANTOM;
277 if ($server_url == "") {
282 "SELECT `id` FROM `gserver` WHERE `nurl` = '%s' AND `last_contact` > `last_failure`",
283 dbesc(normalise_link($server_url))
286 if (DBM::is_result($r)) {
290 // Fetch the host-meta to check if this really is a server
291 $serverret = z_fetch_url($server_url."/.well-known/host-meta");
292 if (!$serverret["success"]) {
299 public static function alternateOStatusUrl($url)
301 return(preg_match("=https?://.+/user/\d+=ism", $url, $matches));
304 public static function lastUpdated($profile, $force = false)
307 "SELECT * FROM `gcontact` WHERE `nurl` = '%s'",
308 dbesc(normalise_link($profile))
311 if (!DBM::is_result($gcontacts)) {
315 $contact = ["url" => $profile];
317 if ($gcontacts[0]["created"] <= NULL_DATE) {
318 $contact['created'] = datetime_convert();
322 $server_url = normalise_link(self::detectServer($profile));
325 if (($server_url == '') && ($gcontacts[0]["server_url"] != "")) {
326 $server_url = $gcontacts[0]["server_url"];
329 if (!$force && (($server_url == '') || ($gcontacts[0]["server_url"] == $gcontacts[0]["nurl"]))) {
330 $server_url = normalise_link(self::detectServer($profile));
333 if (!in_array($gcontacts[0]["network"], [NETWORK_DFRN, NETWORK_DIASPORA, NETWORK_FEED, NETWORK_OSTATUS, ""])) {
334 logger("Profile ".$profile.": Network type ".$gcontacts[0]["network"]." can't be checked", LOGGER_DEBUG);
338 if ($server_url != "") {
339 if (!self::checkServer($server_url, $gcontacts[0]["network"], $force)) {
341 $fields = ['last_failure' => datetime_convert()];
342 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
345 logger("Profile ".$profile.": Server ".$server_url." wasn't reachable.", LOGGER_DEBUG);
348 $contact['server_url'] = $server_url;
351 if (in_array($gcontacts[0]["network"], ["", NETWORK_FEED])) {
353 "SELECT `network` FROM `gserver` WHERE `nurl` = '%s' AND `network` != ''",
354 dbesc(normalise_link($server_url))
358 $contact['network'] = $server[0]["network"];
364 // noscrape is really fast so we don't cache the call.
365 if (($server_url != "") && ($gcontacts[0]["nick"] != "")) {
366 // Use noscrape if possible
367 $server = q("SELECT `noscrape`, `network` FROM `gserver` WHERE `nurl` = '%s' AND `noscrape` != ''", dbesc(normalise_link($server_url)));
370 $noscraperet = z_fetch_url($server[0]["noscrape"]."/".$gcontacts[0]["nick"]);
372 if ($noscraperet["success"] && ($noscraperet["body"] != "")) {
373 $noscrape = json_decode($noscraperet["body"], true);
375 if (is_array($noscrape)) {
376 $contact["network"] = $server[0]["network"];
378 if (isset($noscrape["fn"])) {
379 $contact["name"] = $noscrape["fn"];
381 if (isset($noscrape["comm"])) {
382 $contact["community"] = $noscrape["comm"];
384 if (isset($noscrape["tags"])) {
385 $keywords = implode(" ", $noscrape["tags"]);
386 if ($keywords != "") {
387 $contact["keywords"] = $keywords;
391 $location = Profile::formatLocation($noscrape);
393 $contact["location"] = $location;
395 if (isset($noscrape["dfrn-notify"])) {
396 $contact["notify"] = $noscrape["dfrn-notify"];
398 // Remove all fields that are not present in the gcontact table
399 unset($noscrape["fn"]);
400 unset($noscrape["key"]);
401 unset($noscrape["homepage"]);
402 unset($noscrape["comm"]);
403 unset($noscrape["tags"]);
404 unset($noscrape["locality"]);
405 unset($noscrape["region"]);
406 unset($noscrape["country-name"]);
407 unset($noscrape["contacts"]);
408 unset($noscrape["dfrn-request"]);
409 unset($noscrape["dfrn-confirm"]);
410 unset($noscrape["dfrn-notify"]);
411 unset($noscrape["dfrn-poll"]);
413 // Set the date of the last contact
414 /// @todo By now the function "update_gcontact" doesn't work with this field
415 //$contact["last_contact"] = datetime_convert();
417 $contact = array_merge($contact, $noscrape);
419 GContact::update($contact);
421 if (trim($noscrape["updated"]) != "") {
422 $fields = ['last_contact' => datetime_convert()];
423 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
425 logger("Profile ".$profile." was last updated at ".$noscrape["updated"]." (noscrape)", LOGGER_DEBUG);
427 return $noscrape["updated"];
434 // If we only can poll the feed, then we only do this once a while
435 if (!$force && !self::updateNeeded($gcontacts[0]["created"], $gcontacts[0]["updated"], $gcontacts[0]["last_failure"], $gcontacts[0]["last_contact"])) {
436 logger("Profile ".$profile." was last updated at ".$gcontacts[0]["updated"]." (cached)", LOGGER_DEBUG);
438 GContact::update($contact);
439 return $gcontacts[0]["updated"];
442 $data = Probe::uri($profile);
444 // Is the profile link the alternate OStatus link notation? (http://domain.tld/user/4711)
445 // Then check the other link and delete this one
446 if (($data["network"] == NETWORK_OSTATUS) && self::alternateOStatusUrl($profile)
447 && (normalise_link($profile) == normalise_link($data["alias"]))
448 && (normalise_link($profile) != normalise_link($data["url"]))
450 // Delete the old entry
451 dba::delete('gcontact', ['nurl' => normalise_link($profile)]);
453 $gcontact = array_merge($gcontacts[0], $data);
455 $gcontact["server_url"] = $data["baseurl"];
458 $gcontact = GContact::sanitize($gcontact);
459 GContact::update($gcontact);
461 self::lastUpdated($data["url"], $force);
462 } catch (Exception $e) {
463 logger($e->getMessage(), LOGGER_DEBUG);
466 logger("Profile ".$profile." was deleted", LOGGER_DEBUG);
470 if (($data["poll"] == "") || (in_array($data["network"], [NETWORK_FEED, NETWORK_PHANTOM]))) {
471 $fields = ['last_failure' => datetime_convert()];
472 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
474 logger("Profile ".$profile." wasn't reachable (profile)", LOGGER_DEBUG);
478 $contact = array_merge($contact, $data);
480 $contact["server_url"] = $data["baseurl"];
482 GContact::update($contact);
484 $feedret = z_fetch_url($data["poll"]);
486 if (!$feedret["success"]) {
487 $fields = ['last_failure' => datetime_convert()];
488 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
490 logger("Profile ".$profile." wasn't reachable (no feed)", LOGGER_DEBUG);
494 $doc = new DOMDocument();
495 @$doc->loadXML($feedret["body"]);
497 $xpath = new DOMXPath($doc);
498 $xpath->registerNamespace('atom', "http://www.w3.org/2005/Atom");
500 $entries = $xpath->query('/atom:feed/atom:entry');
504 foreach ($entries as $entry) {
505 $published = $xpath->query('atom:published/text()', $entry)->item(0)->nodeValue;
506 $updated = $xpath->query('atom:updated/text()', $entry)->item(0)->nodeValue;
508 if ($last_updated < $published)
509 $last_updated = $published;
511 if ($last_updated < $updated)
512 $last_updated = $updated;
515 // Maybe there aren't any entries. Then check if it is a valid feed
516 if ($last_updated == "") {
517 if ($xpath->query('/atom:feed')->length > 0) {
518 $last_updated = NULL_DATE;
521 $fields = ['updated' => DBM::date($last_updated), 'last_contact' => DBM::date()];
522 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
524 if (($gcontacts[0]["generation"] == 0)) {
525 $fields = ['generation' => 9];
526 dba::update('gcontact', $fields, ['nurl' => normalise_link($profile)]);
529 logger("Profile ".$profile." was last updated at ".$last_updated, LOGGER_DEBUG);
531 return($last_updated);
534 public static function updateNeeded($created, $updated, $last_failure, $last_contact)
536 $now = strtotime(datetime_convert());
538 if ($updated > $last_contact) {
539 $contact_time = strtotime($updated);
541 $contact_time = strtotime($last_contact);
544 $failure_time = strtotime($last_failure);
545 $created_time = strtotime($created);
547 // If there is no "created" time then use the current time
548 if ($created_time <= 0) {
549 $created_time = $now;
552 // If the last contact was less than 24 hours then don't update
553 if (($now - $contact_time) < (60 * 60 * 24)) {
557 // If the last failure was less than 24 hours then don't update
558 if (($now - $failure_time) < (60 * 60 * 24)) {
562 // If the last contact was less than a week ago and the last failure is older than a week then don't update
563 //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
566 // 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
567 if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
571 // 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
572 if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
579 private static function toBoolean($val)
581 if (($val == "true") || ($val == 1)) {
583 } elseif (($val == "false") || ($val == 0)) {
591 * @brief Detect server type (Hubzilla or Friendica) via the poco data
593 * @param object $data POCO data
594 * @return array Server data
596 private static function detectPocoData($data)
600 if (!isset($data->entry)) {
604 if (count($data->entry) == 0) {
608 if (!isset($data->entry[0]->urls)) {
612 if (count($data->entry[0]->urls) == 0) {
616 foreach ($data->entry[0]->urls as $url) {
617 if ($url->type == 'zot') {
619 $server["platform"] = 'Hubzilla';
620 $server["network"] = NETWORK_DIASPORA;
628 * @brief Detect server type by using the nodeinfo data
630 * @param string $server_url address of the server
631 * @return array Server data
633 private static function fetchNodeinfo($server_url)
635 $serverret = z_fetch_url($server_url."/.well-known/nodeinfo");
636 if (!$serverret["success"]) {
640 $nodeinfo = json_decode($serverret['body']);
642 if (!is_object($nodeinfo)) {
646 if (!is_array($nodeinfo->links)) {
652 foreach ($nodeinfo->links as $link) {
653 if ($link->rel == 'http://nodeinfo.diaspora.software/ns/schema/1.0') {
654 $nodeinfo_url = $link->href;
658 if ($nodeinfo_url == '') {
662 // When the nodeinfo url isn't on the same host, then there is obviously something wrong
663 if (parse_url($server_url, PHP_URL_HOST) != parse_url($nodeinfo_url, PHP_URL_HOST)) {
667 $serverret = z_fetch_url($nodeinfo_url);
668 if (!$serverret["success"]) {
672 $nodeinfo = json_decode($serverret['body']);
674 if (!is_object($nodeinfo)) {
680 $server['register_policy'] = REGISTER_CLOSED;
682 if (is_bool($nodeinfo->openRegistrations) && $nodeinfo->openRegistrations) {
683 $server['register_policy'] = REGISTER_OPEN;
686 if (is_object($nodeinfo->software)) {
687 if (isset($nodeinfo->software->name)) {
688 $server['platform'] = $nodeinfo->software->name;
691 if (isset($nodeinfo->software->version)) {
692 $server['version'] = $nodeinfo->software->version;
693 // Version numbers on Nodeinfo are presented with additional info, e.g.:
694 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
695 $server['version'] = preg_replace("=(.+)-(.{4,})=ism", "$1", $server['version']);
699 if (is_object($nodeinfo->metadata)) {
700 if (isset($nodeinfo->metadata->nodeName)) {
701 $server['site_name'] = $nodeinfo->metadata->nodeName;
705 if (!empty($nodeinfo->usage->users->total)) {
706 $server['registered-users'] = $nodeinfo->usage->users->total;
713 if (is_array($nodeinfo->protocols->inbound)) {
714 foreach ($nodeinfo->protocols->inbound as $inbound) {
715 if ($inbound == 'diaspora') {
718 if ($inbound == 'friendica') {
721 if ($inbound == 'gnusocial') {
728 $server['network'] = NETWORK_OSTATUS;
731 $server['network'] = NETWORK_DIASPORA;
734 $server['network'] = NETWORK_DFRN;
745 * @brief Detect server type (Hubzilla or Friendica) via the front page body
747 * @param string $body Front page of the server
748 * @return array Server data
750 private static function detectServerType($body)
754 $doc = new DOMDocument();
755 @$doc->loadHTML($body);
756 $xpath = new DOMXPath($doc);
758 $list = $xpath->query("//meta[@name]");
760 foreach ($list as $node) {
762 if ($node->attributes->length) {
763 foreach ($node->attributes as $attribute) {
764 $attr[$attribute->name] = $attribute->value;
767 if ($attr['name'] == 'generator') {
768 $version_part = explode(" ", $attr['content']);
769 if (count($version_part) == 2) {
770 if (in_array($version_part[0], ["Friendika", "Friendica"])) {
772 $server["platform"] = $version_part[0];
773 $server["version"] = $version_part[1];
774 $server["network"] = NETWORK_DFRN;
781 $list = $xpath->query("//meta[@property]");
783 foreach ($list as $node) {
785 if ($node->attributes->length) {
786 foreach ($node->attributes as $attribute) {
787 $attr[$attribute->name] = $attribute->value;
790 if ($attr['property'] == 'generator' && in_array($attr['content'], ["hubzilla", "BlaBlaNet"])) {
792 $server["platform"] = $attr['content'];
793 $server["version"] = "";
794 $server["network"] = NETWORK_DIASPORA;
803 $server["site_name"] = $xpath->evaluate("//head/title/text()")->item(0)->nodeValue;
807 public static function checkServer($server_url, $network = "", $force = false)
809 // Unify the server address
810 $server_url = trim($server_url, "/");
811 $server_url = str_replace("/index.php", "", $server_url);
813 if ($server_url == "") {
817 $gserver = dba::selectFirst('gserver', [], ['nurl' => normalise_link($server_url)]);
818 if (DBM::is_result($gserver)) {
819 if ($gserver["created"] <= NULL_DATE) {
820 $fields = ['created' => datetime_convert()];
821 $condition = ['nurl' => normalise_link($server_url)];
822 dba::update('gserver', $fields, $condition);
824 $poco = $gserver["poco"];
825 $noscrape = $gserver["noscrape"];
827 if ($network == "") {
828 $network = $gserver["network"];
831 $last_contact = $gserver["last_contact"];
832 $last_failure = $gserver["last_failure"];
833 $version = $gserver["version"];
834 $platform = $gserver["platform"];
835 $site_name = $gserver["site_name"];
836 $info = $gserver["info"];
837 $register_policy = $gserver["register_policy"];
838 $registered_users = $gserver["registered-users"];
840 if (!$force && !self::updateNeeded($gserver["created"], "", $last_failure, $last_contact)) {
841 logger("Use cached data for server ".$server_url, LOGGER_DEBUG);
842 return ($last_contact >= $last_failure);
851 $register_policy = -1;
852 $registered_users = 0;
854 $last_contact = NULL_DATE;
855 $last_failure = NULL_DATE;
857 logger("Server ".$server_url." is outdated or unknown. Start discovery. Force: ".$force." Created: ".$gserver["created"]." Failure: ".$last_failure." Contact: ".$last_contact, LOGGER_DEBUG);
860 $possible_failure = false;
861 $orig_last_failure = $last_failure;
862 $orig_last_contact = $last_contact;
864 // Mastodon uses the "@" for user profiles.
865 // But this can be misunderstood.
866 if (parse_url($server_url, PHP_URL_USER) != '') {
867 dba::update('gserver', ['last_failure' => datetime_convert()], ['nurl' => normalise_link($server_url)]);
871 // Check if the page is accessible via SSL.
872 $orig_server_url = $server_url;
873 $server_url = str_replace("http://", "https://", $server_url);
875 // We set the timeout to 20 seconds since this operation should be done in no time if the server was vital
876 $serverret = z_fetch_url($server_url."/.well-known/host-meta", false, $redirects, ['timeout' => 20]);
878 // Quit if there is a timeout.
879 // But we want to make sure to only quit if we are mostly sure that this server url fits.
880 if (DBM::is_result($gserver) && ($orig_server_url == $server_url) &&
881 ($serverret['errno'] == CURLE_OPERATION_TIMEDOUT)) {
882 logger("Connection to server ".$server_url." timed out.", LOGGER_DEBUG);
883 dba::update('gserver', ['last_failure' => datetime_convert()], ['nurl' => normalise_link($server_url)]);
887 // Maybe the page is unencrypted only?
888 $xmlobj = @simplexml_load_string($serverret["body"], 'SimpleXMLElement', 0, "http://docs.oasis-open.org/ns/xri/xrd-1.0");
889 if (!$serverret["success"] || ($serverret["body"] == "") || (@sizeof($xmlobj) == 0) || !is_object($xmlobj)) {
890 $server_url = str_replace("https://", "http://", $server_url);
892 // We set the timeout to 20 seconds since this operation should be done in no time if the server was vital
893 $serverret = z_fetch_url($server_url."/.well-known/host-meta", false, $redirects, ['timeout' => 20]);
895 // Quit if there is a timeout
896 if ($serverret['errno'] == CURLE_OPERATION_TIMEDOUT) {
897 logger("Connection to server ".$server_url." timed out.", LOGGER_DEBUG);
898 dba::update('gserver', ['last_failure' => datetime_convert()], ['nurl' => normalise_link($server_url)]);
902 $xmlobj = @simplexml_load_string($serverret["body"], 'SimpleXMLElement', 0, "http://docs.oasis-open.org/ns/xri/xrd-1.0");
905 if (!$serverret["success"] || ($serverret["body"] == "") || (sizeof($xmlobj) == 0) || !is_object($xmlobj)) {
906 // Workaround for bad configured servers (known nginx problem)
907 if (!in_array($serverret["debug"]["http_code"], ["403", "404"])) {
910 $possible_failure = true;
913 // If the server has no possible failure we reset the cached data
914 if (!$possible_failure) {
919 $register_policy = -1;
923 // This will be too low, but better than no value at all.
924 $registered_users = dba::count('gcontact', ['server_url' => normalise_link($server_url)]);
929 $serverret = z_fetch_url($server_url."/poco");
930 if ($serverret["success"]) {
931 $data = json_decode($serverret["body"]);
932 if (isset($data->totalResults)) {
933 $registered_users = $data->totalResults;
934 $poco = $server_url."/poco";
935 $server = self::detectPocoData($data);
937 $platform = $server['platform'];
938 $network = $server['network'];
943 // There are servers out there who don't return 404 on a failure
944 // We have to be sure that don't misunderstand this
945 if (is_null($data)) {
954 // Test for Diaspora, Hubzilla, Mastodon or older Friendica servers
955 $serverret = z_fetch_url($server_url);
957 if (!$serverret["success"] || ($serverret["body"] == "")) {
960 $server = self::detectServerType($serverret["body"]);
962 $platform = $server['platform'];
963 $network = $server['network'];
964 $version = $server['version'];
965 $site_name = $server['site_name'];
968 $lines = explode("\n", $serverret["header"]);
970 foreach ($lines as $line) {
972 if (stristr($line, 'X-Diaspora-Version:')) {
973 $platform = "Diaspora";
974 $version = trim(str_replace("X-Diaspora-Version:", "", $line));
975 $version = trim(str_replace("x-diaspora-version:", "", $version));
976 $network = NETWORK_DIASPORA;
977 $versionparts = explode("-", $version);
978 $version = $versionparts[0];
981 if (stristr($line, 'Server: Mastodon')) {
982 $platform = "Mastodon";
983 $network = NETWORK_OSTATUS;
990 if (!$failure && ($poco == "")) {
991 // Test for Statusnet
992 // Will also return data for Friendica and GNU Social - but it will be overwritten later
993 // The "not implemented" is a special treatment for really, really old Friendica versions
994 $serverret = z_fetch_url($server_url."/api/statusnet/version.json");
995 if ($serverret["success"] && ($serverret["body"] != '{"error":"not implemented"}') &&
996 ($serverret["body"] != '') && (strlen($serverret["body"]) < 30)) {
997 $platform = "StatusNet";
998 // Remove junk that some GNU Social servers return
999 $version = str_replace(chr(239).chr(187).chr(191), "", $serverret["body"]);
1000 $version = trim($version, '"');
1001 $network = NETWORK_OSTATUS;
1004 // Test for GNU Social
1005 $serverret = z_fetch_url($server_url."/api/gnusocial/version.json");
1006 if ($serverret["success"] && ($serverret["body"] != '{"error":"not implemented"}') &&
1007 ($serverret["body"] != '') && (strlen($serverret["body"]) < 30)) {
1008 $platform = "GNU Social";
1009 // Remove junk that some GNU Social servers return
1010 $version = str_replace(chr(239).chr(187).chr(191), "", $serverret["body"]);
1011 $version = trim($version, '"');
1012 $network = NETWORK_OSTATUS;
1015 // Test for Mastodon
1016 $orig_version = $version;
1017 $serverret = z_fetch_url($server_url."/api/v1/instance");
1018 if ($serverret["success"] && ($serverret["body"] != '')) {
1019 $data = json_decode($serverret["body"]);
1021 if (isset($data->version)) {
1022 $platform = "Mastodon";
1023 $version = $data->version;
1024 $site_name = $data->title;
1025 $info = $data->description;
1026 $network = NETWORK_OSTATUS;
1028 if (!empty($data->stats->user_count)) {
1029 $registered_users = $data->stats->user_count;
1032 if (strstr($orig_version.$version, 'Pleroma')) {
1033 $platform = 'Pleroma';
1034 $version = trim(str_replace('Pleroma', '', $version));
1039 // Test for Hubzilla and Red
1040 $serverret = z_fetch_url($server_url."/siteinfo.json");
1041 if ($serverret["success"]) {
1042 $data = json_decode($serverret["body"]);
1043 if (isset($data->url)) {
1044 $platform = $data->platform;
1045 $version = $data->version;
1046 $network = NETWORK_DIASPORA;
1048 if (!empty($data->site_name)) {
1049 $site_name = $data->site_name;
1051 if (!empty($data->channels_total)) {
1052 $registered_users = $data->channels_total;
1054 switch ($data->register_policy) {
1055 case "REGISTER_OPEN":
1056 $register_policy = REGISTER_OPEN;
1058 case "REGISTER_APPROVE":
1059 $register_policy = REGISTER_APPROVE;
1061 case "REGISTER_CLOSED":
1063 $register_policy = REGISTER_CLOSED;
1067 // Test for Hubzilla, Redmatrix or Friendica
1068 $serverret = z_fetch_url($server_url."/api/statusnet/config.json");
1069 if ($serverret["success"]) {
1070 $data = json_decode($serverret["body"]);
1071 if (isset($data->site->server)) {
1072 if (isset($data->site->platform)) {
1073 $platform = $data->site->platform->PLATFORM_NAME;
1074 $version = $data->site->platform->STD_VERSION;
1075 $network = NETWORK_DIASPORA;
1077 if (isset($data->site->BlaBlaNet)) {
1078 $platform = $data->site->BlaBlaNet->PLATFORM_NAME;
1079 $version = $data->site->BlaBlaNet->STD_VERSION;
1080 $network = NETWORK_DIASPORA;
1082 if (isset($data->site->hubzilla)) {
1083 $platform = $data->site->hubzilla->PLATFORM_NAME;
1084 $version = $data->site->hubzilla->RED_VERSION;
1085 $network = NETWORK_DIASPORA;
1087 if (isset($data->site->redmatrix)) {
1088 if (isset($data->site->redmatrix->PLATFORM_NAME)) {
1089 $platform = $data->site->redmatrix->PLATFORM_NAME;
1090 } elseif (isset($data->site->redmatrix->RED_PLATFORM)) {
1091 $platform = $data->site->redmatrix->RED_PLATFORM;
1094 $version = $data->site->redmatrix->RED_VERSION;
1095 $network = NETWORK_DIASPORA;
1097 if (isset($data->site->friendica)) {
1098 $platform = $data->site->friendica->FRIENDICA_PLATFORM;
1099 $version = $data->site->friendica->FRIENDICA_VERSION;
1100 $network = NETWORK_DFRN;
1103 $site_name = $data->site->name;
1105 $data->site->closed = self::toBoolean($data->site->closed);
1106 $data->site->private = self::toBoolean($data->site->private);
1107 $data->site->inviteonly = self::toBoolean($data->site->inviteonly);
1109 if (!$data->site->closed && !$data->site->private and $data->site->inviteonly) {
1110 $register_policy = REGISTER_APPROVE;
1111 } elseif (!$data->site->closed && !$data->site->private) {
1112 $register_policy = REGISTER_OPEN;
1114 $register_policy = REGISTER_CLOSED;
1121 // Query statistics.json. Optional package for Diaspora, Friendica and Redmatrix
1123 $serverret = z_fetch_url($server_url."/statistics.json");
1124 if ($serverret["success"]) {
1125 $data = json_decode($serverret["body"]);
1127 if (isset($data->version)) {
1128 $version = $data->version;
1129 // Version numbers on statistics.json are presented with additional info, e.g.:
1130 // 0.6.3.0-p1702cc1c, 0.6.99.0-p1b9ab160 or 3.4.3-2-1191.
1131 $version = preg_replace("=(.+)-(.{4,})=ism", "$1", $version);
1134 if (!empty($data->name)) {
1135 $site_name = $data->name;
1138 if (!empty($data->network)) {
1139 $platform = $data->network;
1142 if ($platform == "Diaspora") {
1143 $network = NETWORK_DIASPORA;
1146 if ($data->registrations_open) {
1147 $register_policy = REGISTER_OPEN;
1149 $register_policy = REGISTER_CLOSED;
1154 // Query nodeinfo. Working for (at least) Diaspora and Friendica.
1156 $server = self::fetchNodeinfo($server_url);
1158 $register_policy = $server['register_policy'];
1160 if (isset($server['platform'])) {
1161 $platform = $server['platform'];
1164 if (isset($server['network'])) {
1165 $network = $server['network'];
1168 if (isset($server['version'])) {
1169 $version = $server['version'];
1172 if (isset($server['site_name'])) {
1173 $site_name = $server['site_name'];
1176 if (isset($server['registered-users'])) {
1177 $registered_users = $server['registered-users'];
1182 // Check for noscrape
1183 // Friendica servers could be detected as OStatus servers
1184 if (!$failure && in_array($network, [NETWORK_DFRN, NETWORK_OSTATUS])) {
1185 $serverret = z_fetch_url($server_url."/friendica/json");
1187 if (!$serverret["success"]) {
1188 $serverret = z_fetch_url($server_url."/friendika/json");
1191 if ($serverret["success"]) {
1192 $data = json_decode($serverret["body"]);
1194 if (isset($data->version)) {
1195 $network = NETWORK_DFRN;
1197 $noscrape = $data->no_scrape_url;
1198 $version = $data->version;
1199 $site_name = $data->site_name;
1200 $info = $data->info;
1201 $register_policy_str = $data->register_policy;
1202 $platform = $data->platform;
1204 switch ($register_policy_str) {
1205 case "REGISTER_CLOSED":
1206 $register_policy = REGISTER_CLOSED;
1208 case "REGISTER_APPROVE":
1209 $register_policy = REGISTER_APPROVE;
1211 case "REGISTER_OPEN":
1212 $register_policy = REGISTER_OPEN;
1219 // Every server has got at least an admin account
1220 if (!$failure && ($registered_users == 0)) {
1221 $registered_users = 1;
1224 if ($possible_failure && !$failure) {
1229 $last_contact = $orig_last_contact;
1230 $last_failure = datetime_convert();
1232 $last_contact = datetime_convert();
1233 $last_failure = $orig_last_failure;
1236 if (($last_contact <= $last_failure) && !$failure) {
1237 logger("Server ".$server_url." seems to be alive, but last contact wasn't set - could be a bug", LOGGER_DEBUG);
1238 } elseif (($last_contact >= $last_failure) && $failure) {
1239 logger("Server ".$server_url." seems to be dead, but last failure wasn't set - could be a bug", LOGGER_DEBUG);
1242 // Check again if the server exists
1243 $found = dba::exists('gserver', ['nurl' => normalise_link($server_url)]);
1245 $version = strip_tags($version);
1246 $site_name = strip_tags($site_name);
1247 $info = strip_tags($info);
1248 $platform = strip_tags($platform);
1250 $fields = ['url' => $server_url, 'version' => $version,
1251 'site_name' => $site_name, 'info' => $info, 'register_policy' => $register_policy,
1252 'poco' => $poco, 'noscrape' => $noscrape, 'network' => $network,
1253 'platform' => $platform, 'registered-users' => $registered_users,
1254 'last_contact' => $last_contact, 'last_failure' => $last_failure];
1257 dba::update('gserver', $fields, ['nurl' => normalise_link($server_url)]);
1258 } elseif (!$failure) {
1259 $fields['nurl'] = normalise_link($server_url);
1260 $fields['created'] = datetime_convert();
1261 dba::insert('gserver', $fields);
1263 logger("End discovery for server " . $server_url, LOGGER_DEBUG);
1269 * @brief Returns a list of all known servers
1270 * @return array List of server urls
1272 public static function serverlist()
1275 "SELECT `url`, `site_name` AS `displayName`, `network`, `platform`, `version` FROM `gserver`
1276 WHERE `network` IN ('%s', '%s', '%s') AND `last_contact` > `last_failure`
1277 ORDER BY `last_contact`
1279 dbesc(NETWORK_DFRN),
1280 dbesc(NETWORK_DIASPORA),
1281 dbesc(NETWORK_OSTATUS)
1284 if (!DBM::is_result($r)) {
1292 * @brief Fetch server list from remote servers and adds them when they are new.
1294 * @param string $poco URL to the POCO endpoint
1296 private static function fetchServerlist($poco)
1298 $serverret = z_fetch_url($poco."/@server");
1299 if (!$serverret["success"]) {
1302 $serverlist = json_decode($serverret['body']);
1304 if (!is_array($serverlist)) {
1308 foreach ($serverlist as $server) {
1309 $server_url = str_replace("/index.php", "", $server->url);
1311 $r = q("SELECT `nurl` FROM `gserver` WHERE `nurl` = '%s'", dbesc(normalise_link($server_url)));
1312 if (!DBM::is_result($r)) {
1313 logger("Call server check for server ".$server_url, LOGGER_DEBUG);
1314 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", $server_url);
1319 private static function discoverFederation()
1321 $last = Config::get('poco', 'last_federation_discovery');
1324 $next = $last + (24 * 60 * 60);
1325 if ($next > time()) {
1330 // Discover Friendica, Hubzilla and Diaspora servers
1331 $serverdata = fetch_url("http://the-federation.info/pods.json");
1334 $servers = json_decode($serverdata);
1336 foreach ($servers->pods as $server) {
1337 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", "https://".$server->host);
1341 // Disvover Mastodon servers
1342 if (!Config::get('system', 'ostatus_disabled')) {
1343 $accesstoken = Config::get('system', 'instances_social_key');
1344 if (!empty($accesstoken)) {
1345 $api = 'https://instances.social/api/1.0/instances/list?count=0';
1346 $header = ['Authorization: Bearer '.$accesstoken];
1347 $serverdata = z_fetch_url($api, false, $redirects, ['headers' => $header]);
1348 if ($serverdata['success']) {
1349 $servers = json_decode($serverdata['body']);
1350 foreach ($servers->instances as $server) {
1351 $url = (is_null($server->https_score) ? 'http' : 'https').'://'.$server->name;
1352 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "server", $url);
1358 // Currently disabled, since the service isn't available anymore.
1359 // It is not removed since I hope that there will be a successor.
1360 // Discover GNU Social Servers.
1361 //if (!Config::get('system','ostatus_disabled')) {
1362 // $serverdata = "http://gstools.org/api/get_open_instances/";
1364 // $result = z_fetch_url($serverdata);
1365 // if ($result["success"]) {
1366 // $servers = json_decode($result["body"]);
1368 // foreach($servers->data as $server)
1369 // self::checkServer($server->instance_address);
1373 Config::set('poco', 'last_federation_discovery', time());
1376 public static function discoverSingleServer($id)
1378 $r = q("SELECT `poco`, `nurl`, `url`, `network` FROM `gserver` WHERE `id` = %d", intval($id));
1379 if (!DBM::is_result($r)) {
1385 // Discover new servers out there (Works from Friendica version 3.5.2)
1386 self::fetchServerlist($server["poco"]);
1388 // Fetch all users from the other server
1389 $url = $server["poco"]."/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
1391 logger("Fetch all users from the server ".$server["url"], LOGGER_DEBUG);
1393 $retdata = z_fetch_url($url);
1394 if ($retdata["success"]) {
1395 $data = json_decode($retdata["body"]);
1397 self::discoverServer($data, 2);
1399 if (Config::get('system', 'poco_discovery') > 1) {
1400 $timeframe = Config::get('system', 'poco_discovery_since');
1401 if ($timeframe == 0) {
1405 $updatedSince = date("Y-m-d H:i:s", time() - $timeframe * 86400);
1407 // Fetch all global contacts from the other server (Not working with Redmatrix and Friendica versions before 3.3)
1408 $url = $server["poco"]."/@global?updatedSince=".$updatedSince."&fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
1412 $retdata = z_fetch_url($url);
1413 if ($retdata["success"]) {
1414 logger("Fetch all global contacts from the server ".$server["nurl"], LOGGER_DEBUG);
1415 $success = self::discoverServer(json_decode($retdata["body"]));
1418 if (!$success && (Config::get('system', 'poco_discovery') > 2)) {
1419 logger("Fetch contacts from users of the server ".$server["nurl"], LOGGER_DEBUG);
1420 self::discoverServerUsers($data, $server);
1424 $fields = ['last_poco_query' => datetime_convert()];
1425 dba::update('gserver', $fields, ['nurl' => $server["nurl"]]);
1429 // If the server hadn't replied correctly, then force a sanity check
1430 self::checkServer($server["url"], $server["network"], true);
1432 // If we couldn't reach the server, we will try it some time later
1433 $fields = ['last_poco_query' => datetime_convert()];
1434 dba::update('gserver', $fields, ['nurl' => $server["nurl"]]);
1440 public static function discover($complete = false)
1442 // Update the server list
1443 self::discoverFederation();
1447 $requery_days = intval(Config::get("system", "poco_requery_days"));
1449 if ($requery_days == 0) {
1452 $last_update = date("c", time() - (60 * 60 * 24 * $requery_days));
1454 $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));
1455 if (DBM::is_result($r)) {
1456 foreach ($r as $server) {
1457 if (!self::checkServer($server["url"], $server["network"])) {
1458 // The server is not reachable? Okay, then we will try it later
1459 $fields = ['last_poco_query' => datetime_convert()];
1460 dba::update('gserver', $fields, ['nurl' => $server["nurl"]]);
1464 logger('Update directory from server '.$server['url'].' with ID '.$server['id'], LOGGER_DEBUG);
1465 Worker::add(PRIORITY_LOW, "DiscoverPoCo", "update_server_directory", (int)$server['id']);
1467 if (!$complete && (--$no_of_queries == 0)) {
1474 private static function discoverServerUsers($data, $server)
1476 if (!isset($data->entry)) {
1480 foreach ($data->entry as $entry) {
1482 if (isset($entry->urls)) {
1483 foreach ($entry->urls as $url) {
1484 if ($url->type == 'profile') {
1485 $profile_url = $url->value;
1486 $urlparts = parse_url($profile_url);
1487 $username = end(explode("/", $urlparts["path"]));
1491 if ($username != "") {
1492 logger("Fetch contacts for the user ".$username." from the server ".$server["nurl"], LOGGER_DEBUG);
1494 // Fetch all contacts from a given user from the other server
1495 $url = $server["poco"]."/".$username."/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
1497 $retdata = z_fetch_url($url);
1498 if ($retdata["success"]) {
1499 self::discoverServer(json_decode($retdata["body"]), 3);
1505 private static function discoverServer($data, $default_generation = 0)
1507 if (!isset($data->entry) || !count($data->entry)) {
1513 foreach ($data->entry as $entry) {
1515 $profile_photo = '';
1519 $updated = NULL_DATE;
1525 $generation = $default_generation;
1527 $name = $entry->displayName;
1529 if (isset($entry->urls)) {
1530 foreach ($entry->urls as $url) {
1531 if ($url->type == 'profile') {
1532 $profile_url = $url->value;
1535 if ($url->type == 'webfinger') {
1536 $connect_url = str_replace('acct:' , '', $url->value);
1542 if (isset($entry->photos)) {
1543 foreach ($entry->photos as $photo) {
1544 if ($photo->type == 'profile') {
1545 $profile_photo = $photo->value;
1551 if (isset($entry->updated)) {
1552 $updated = date("Y-m-d H:i:s", strtotime($entry->updated));
1555 if (isset($entry->network)) {
1556 $network = $entry->network;
1559 if (isset($entry->currentLocation)) {
1560 $location = $entry->currentLocation;
1563 if (isset($entry->aboutMe)) {
1564 $about = html2bbcode($entry->aboutMe);
1567 if (isset($entry->gender)) {
1568 $gender = $entry->gender;
1571 if (isset($entry->generation) && ($entry->generation > 0)) {
1572 $generation = ++$entry->generation;
1575 if (isset($entry->contactType) && ($entry->contactType >= 0)) {
1576 $contact_type = $entry->contactType;
1579 if (isset($entry->tags)) {
1580 foreach ($entry->tags as $tag) {
1581 $keywords = implode(", ", $tag);
1585 if ($generation > 0) {
1588 logger("Store profile ".$profile_url, LOGGER_DEBUG);
1590 $gcontact = ["url" => $profile_url,
1592 "network" => $network,
1593 "photo" => $profile_photo,
1595 "location" => $location,
1596 "gender" => $gender,
1597 "keywords" => $keywords,
1598 "connect" => $connect_url,
1599 "updated" => $updated,
1600 "contact-type" => $contact_type,
1601 "generation" => $generation];
1604 $gcontact = GContact::sanitize($gcontact);
1605 GContact::update($gcontact);
1606 } catch (Exception $e) {
1607 logger($e->getMessage(), LOGGER_DEBUG);
1610 logger("Done for profile ".$profile_url, LOGGER_DEBUG);