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;
15 use Friendica\Content\Text\HTML;
16 use Friendica\Core\Config;
17 use Friendica\Core\Logger;
18 use Friendica\Core\Protocol;
19 use Friendica\Core\Worker;
20 use Friendica\Database\DBA;
21 use Friendica\Model\Contact;
22 use Friendica\Model\GContact;
23 use Friendica\Model\GServer;
24 use Friendica\Model\Profile;
25 use Friendica\Module\Register;
26 use Friendica\Network\Probe;
27 use Friendica\Util\DateTimeFormat;
28 use Friendica\Util\Network;
29 use Friendica\Util\Strings;
30 use Friendica\Util\XML;
36 const USERS_GCONTACTS = 2;
37 const USERS_GCONTACTS_FALLBACK = 3;
40 * @brief Fetch POCO data
42 * @param integer $cid Contact ID
43 * @param integer $uid User ID
44 * @param integer $zcid Global Contact ID
45 * @param integer $url POCO address that should be polled
47 * Given a contact-id (minimum), load the PortableContacts friend list for that contact,
48 * and add the entries to the gcontact (Global Contact) table, or update existing entries
49 * if anything (name or photo) has changed.
50 * We use normalised urls for comparison which ignore http vs https and www.domain vs domain
52 * Once the global contact is stored add (if necessary) the contact linkage which associates
53 * the given uid, cid to the global contact entry. There can be many uid/cid combinations
54 * pointing to the same global contact id.
55 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
57 public static function loadWorker($cid, $uid = 0, $zcid = 0, $url = null)
59 // Call the function "load" via the worker
60 Worker::add(PRIORITY_LOW, 'FetchPoCo', (int)$cid, (int)$uid, (int)$zcid, $url);
64 * @brief Fetch POCO data from the worker
66 * @param integer $cid Contact ID
67 * @param integer $uid User ID
68 * @param integer $zcid Global Contact ID
69 * @param integer $url POCO address that should be polled
70 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
72 public static function load($cid, $uid, $zcid, $url)
76 $contact = DBA::selectFirst('contact', ['poco', 'uid'], ['id' => $cid]);
77 if (DBA::isResult($contact)) {
78 $url = $contact['poco'];
79 $uid = $contact['uid'];
91 $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');
93 Logger::log('load: ' . $url, Logger::DEBUG);
95 $fetchresult = Network::fetchUrlFull($url);
96 $s = $fetchresult->getBody();
98 Logger::log('load: returns ' . $s, Logger::DATA);
100 Logger::log('load: return code: ' . $fetchresult->getReturnCode(), Logger::DEBUG);
102 if (($fetchresult->getReturnCode() > 299) || (! $s)) {
106 $j = json_decode($s, true);
108 Logger::log('load: json: ' . print_r($j, true), Logger::DATA);
110 if (!isset($j['entry'])) {
115 foreach ($j['entry'] as $entry) {
122 $updated = DBA::NULL_DATETIME;
130 if (!empty($entry['displayName'])) {
131 $name = $entry['displayName'];
134 if (isset($entry['urls'])) {
135 foreach ($entry['urls'] as $url) {
136 if ($url['type'] == 'profile') {
137 $profile_url = $url['value'];
140 if ($url['type'] == 'webfinger') {
141 $connect_url = str_replace('acct:', '', $url['value']);
146 if (isset($entry['photos'])) {
147 foreach ($entry['photos'] as $photo) {
148 if ($photo['type'] == 'profile') {
149 $profile_photo = $photo['value'];
155 if (isset($entry['updated'])) {
156 $updated = date(DateTimeFormat::MYSQL, strtotime($entry['updated']));
159 if (isset($entry['network'])) {
160 $network = $entry['network'];
163 if (isset($entry['currentLocation'])) {
164 $location = $entry['currentLocation'];
167 if (isset($entry['aboutMe'])) {
168 $about = HTML::toBBCode($entry['aboutMe']);
171 if (isset($entry['gender'])) {
172 $gender = $entry['gender'];
175 if (isset($entry['generation']) && ($entry['generation'] > 0)) {
176 $generation = ++$entry['generation'];
179 if (isset($entry['tags'])) {
180 foreach ($entry['tags'] as $tag) {
181 $keywords = implode(", ", $tag);
185 if (isset($entry['contactType']) && ($entry['contactType'] >= 0)) {
186 $contact_type = $entry['contactType'];
189 $gcontact = ["url" => $profile_url,
191 "network" => $network,
192 "photo" => $profile_photo,
194 "location" => $location,
196 "keywords" => $keywords,
197 "connect" => $connect_url,
198 "updated" => $updated,
199 "contact-type" => $contact_type,
200 "generation" => $generation];
203 $gcontact = GContact::sanitize($gcontact);
204 $gcid = GContact::update($gcontact);
206 GContact::link($gcid, $uid, $cid, $zcid);
207 } catch (Exception $e) {
208 Logger::log($e->getMessage(), Logger::DEBUG);
211 Logger::log("load: loaded $total entries", Logger::DEBUG);
213 $condition = ["`cid` = ? AND `uid` = ? AND `zcid` = ? AND `updated` < UTC_TIMESTAMP - INTERVAL 2 DAY", $cid, $uid, $zcid];
214 DBA::delete('glink', $condition);
217 public static function alternateOStatusUrl($url)
219 return(preg_match("=https?://.+/user/\d+=ism", $url, $matches));
222 public static function updateNeeded($created, $updated, $last_failure, $last_contact)
224 $now = strtotime(DateTimeFormat::utcNow());
226 if ($updated > $last_contact) {
227 $contact_time = strtotime($updated);
229 $contact_time = strtotime($last_contact);
232 $failure_time = strtotime($last_failure);
233 $created_time = strtotime($created);
235 // If there is no "created" time then use the current time
236 if ($created_time <= 0) {
237 $created_time = $now;
240 // If the last contact was less than 24 hours then don't update
241 if (($now - $contact_time) < (60 * 60 * 24)) {
245 // If the last failure was less than 24 hours then don't update
246 if (($now - $failure_time) < (60 * 60 * 24)) {
250 // If the last contact was less than a week ago and the last failure is older than a week then don't update
251 //if ((($now - $contact_time) < (60 * 60 * 24 * 7)) && ($contact_time > $failure_time))
254 // 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
255 if ((($now - $contact_time) > (60 * 60 * 24 * 7)) && (($now - $created_time) > (60 * 60 * 24 * 7)) && (($now - $failure_time) < (60 * 60 * 24 * 7))) {
259 // 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
260 if ((($now - $contact_time) > (60 * 60 * 24 * 30)) && (($now - $created_time) > (60 * 60 * 24 * 30)) && (($now - $failure_time) < (60 * 60 * 24 * 30))) {
268 * @brief Returns a list of all known servers
269 * @return array List of server urls
272 public static function serverlist()
275 "SELECT `url`, `site_name` AS `displayName`, `network`, `platform`, `version` FROM `gserver`
276 WHERE `network` IN ('%s', '%s', '%s') AND `last_contact` > `last_failure`
277 ORDER BY `last_contact`
279 DBA::escape(Protocol::DFRN),
280 DBA::escape(Protocol::DIASPORA),
281 DBA::escape(Protocol::OSTATUS)
284 if (!DBA::isResult($r)) {
292 * @brief Fetch server list from remote servers and adds them when they are new.
294 * @param string $poco URL to the POCO endpoint
295 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
297 private static function fetchServerlist($poco)
299 $curlResult = Network::curl($poco . "/@server");
301 if (!$curlResult->isSuccess()) {
305 $serverlist = json_decode($curlResult->getBody(), true);
307 if (!is_array($serverlist)) {
311 foreach ($serverlist as $server) {
312 $server_url = str_replace("/index.php", "", $server['url']);
314 $r = q("SELECT `nurl` FROM `gserver` WHERE `nurl` = '%s'", DBA::escape(Strings::normaliseLink($server_url)));
316 if (!DBA::isResult($r)) {
317 Logger::log("Call server check for server ".$server_url, Logger::DEBUG);
318 Worker::add(PRIORITY_LOW, 'CheckServer', $server_url);
323 private static function discoverFederation()
325 $last = Config::get('poco', 'last_federation_discovery');
328 $next = $last + (24 * 60 * 60);
330 if ($next > time()) {
335 // Discover Friendica, Hubzilla and Diaspora servers
336 $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
338 if (!empty($curlResult)) {
339 $servers = json_decode($curlResult, true);
341 if (!empty($servers['pods'])) {
342 foreach ($servers['pods'] as $server) {
343 Worker::add(PRIORITY_LOW, 'CheckServer', 'https://' . $server['host']);
348 // Disvover Mastodon servers
349 if (!Config::get('system', 'ostatus_disabled')) {
350 $accesstoken = Config::get('system', 'instances_social_key');
352 if (!empty($accesstoken)) {
353 $api = 'https://instances.social/api/1.0/instances/list?count=0';
354 $header = ['Authorization: Bearer '.$accesstoken];
355 $curlResult = Network::curl($api, false, ['headers' => $header]);
357 if ($curlResult->isSuccess()) {
358 $servers = json_decode($curlResult->getBody(), true);
360 foreach ($servers['instances'] as $server) {
361 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
362 Worker::add(PRIORITY_LOW, 'CheckServer', $url);
368 // Currently disabled, since the service isn't available anymore.
369 // It is not removed since I hope that there will be a successor.
370 // Discover GNU Social Servers.
371 //if (!Config::get('system','ostatus_disabled')) {
372 // $serverdata = "http://gstools.org/api/get_open_instances/";
374 // $curlResult = Network::curl($serverdata);
375 // if ($curlResult->isSuccess()) {
376 // $servers = json_decode($result->getBody(), true);
378 // foreach($servers['data'] as $server)
379 // GServer::check($server['instance_address']);
383 Config::set('poco', 'last_federation_discovery', time());
386 public static function discoverSingleServer($id)
388 $server = DBA::selectFirst('gserver', ['poco', 'nurl', 'url', 'network'], ['id' => $id]);
390 if (!DBA::isResult($server)) {
394 // Discover new servers out there (Works from Friendica version 3.5.2)
395 self::fetchServerlist($server["poco"]);
397 // Fetch all users from the other server
398 $url = $server["poco"] . "/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
400 Logger::info("Fetch all users from the server " . $server["url"]);
402 $curlResult = Network::curl($url);
404 if ($curlResult->isSuccess() && !empty($curlResult->getBody())) {
405 $data = json_decode($curlResult->getBody(), true);
408 self::discoverServer($data, 2);
411 if (Config::get('system', 'poco_discovery') >= self::USERS_GCONTACTS) {
412 $timeframe = Config::get('system', 'poco_discovery_since');
414 if ($timeframe == 0) {
418 $updatedSince = date(DateTimeFormat::MYSQL, time() - $timeframe * 86400);
420 // Fetch all global contacts from the other server (Not working with Redmatrix and Friendica versions before 3.3)
421 $url = $server["poco"]."/@global?updatedSince=".$updatedSince."&fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
425 $curlResult = Network::curl($url);
427 if ($curlResult->isSuccess() && !empty($curlResult->getBody())) {
428 Logger::info("Fetch all global contacts from the server " . $server["nurl"]);
429 $data = json_decode($curlResult->getBody(), true);
432 $success = self::discoverServer($data);
436 if (!$success && !empty($data) && Config::get('system', 'poco_discovery') >= self::USERS_GCONTACTS_FALLBACK) {
437 Logger::info("Fetch contacts from users of the server " . $server["nurl"]);
438 self::discoverServerUsers($data, $server);
442 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
443 DBA::update('gserver', $fields, ['nurl' => $server["nurl"]]);
447 // If the server hadn't replied correctly, then force a sanity check
448 GServer::check($server["url"], $server["network"], true);
450 // If we couldn't reach the server, we will try it some time later
451 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
452 DBA::update('gserver', $fields, ['nurl' => $server["nurl"]]);
458 public static function discover($complete = false)
460 // Update the server list
461 self::discoverFederation();
465 $requery_days = intval(Config::get('system', 'poco_requery_days'));
467 if ($requery_days == 0) {
471 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
473 $gservers = q("SELECT `id`, `url`, `nurl`, `network`
475 WHERE `last_contact` >= `last_failure`
477 AND `last_poco_query` < '%s'
478 ORDER BY RAND()", DBA::escape($last_update)
481 if (DBA::isResult($gservers)) {
482 foreach ($gservers as $gserver) {
483 if (!GServer::check($gserver['url'], $gserver['network'])) {
484 // The server is not reachable? Okay, then we will try it later
485 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
486 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
490 Logger::log('Update directory from server ' . $gserver['url'] . ' with ID ' . $gserver['id'], Logger::DEBUG);
491 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', (int)$gserver['id']);
493 if (!$complete && ( --$no_of_queries == 0)) {
500 private static function discoverServerUsers(array $data, array $server)
502 if (!isset($data['entry'])) {
506 foreach ($data['entry'] as $entry) {
509 if (isset($entry['urls'])) {
510 foreach ($entry['urls'] as $url) {
511 if ($url['type'] == 'profile') {
512 $profile_url = $url['value'];
513 $path_array = explode('/', parse_url($profile_url, PHP_URL_PATH));
514 $username = end($path_array);
519 if ($username != '') {
520 Logger::log('Fetch contacts for the user ' . $username . ' from the server ' . $server['nurl'], Logger::DEBUG);
522 // Fetch all contacts from a given user from the other server
523 $url = $server['poco'] . '/' . $username . '/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation';
525 $curlResult = Network::curl($url);
527 if ($curlResult->isSuccess()) {
528 $data = json_decode($curlResult->getBody(), true);
531 self::discoverServer($data, 3);
538 private static function discoverServer(array $data, $default_generation = 0)
540 if (empty($data['entry'])) {
546 foreach ($data['entry'] as $entry) {
552 $updated = DBA::NULL_DATETIME;
558 $generation = $default_generation;
560 if (!empty($entry['displayName'])) {
561 $name = $entry['displayName'];
564 if (isset($entry['urls'])) {
565 foreach ($entry['urls'] as $url) {
566 if ($url['type'] == 'profile') {
567 $profile_url = $url['value'];
570 if ($url['type'] == 'webfinger') {
571 $connect_url = str_replace('acct:' , '', $url['value']);
577 if (isset($entry['photos'])) {
578 foreach ($entry['photos'] as $photo) {
579 if ($photo['type'] == 'profile') {
580 $profile_photo = $photo['value'];
586 if (isset($entry['updated'])) {
587 $updated = date(DateTimeFormat::MYSQL, strtotime($entry['updated']));
590 if (isset($entry['network'])) {
591 $network = $entry['network'];
594 if (isset($entry['currentLocation'])) {
595 $location = $entry['currentLocation'];
598 if (isset($entry['aboutMe'])) {
599 $about = HTML::toBBCode($entry['aboutMe']);
602 if (isset($entry['gender'])) {
603 $gender = $entry['gender'];
606 if (isset($entry['generation']) && ($entry['generation'] > 0)) {
607 $generation = ++$entry['generation'];
610 if (isset($entry['contactType']) && ($entry['contactType'] >= 0)) {
611 $contact_type = $entry['contactType'];
614 if (isset($entry['tags'])) {
615 foreach ($entry['tags'] as $tag) {
616 $keywords = implode(", ", $tag);
620 if ($generation > 0) {
623 Logger::log("Store profile ".$profile_url, Logger::DEBUG);
625 $gcontact = ["url" => $profile_url,
627 "network" => $network,
628 "photo" => $profile_photo,
630 "location" => $location,
632 "keywords" => $keywords,
633 "connect" => $connect_url,
634 "updated" => $updated,
635 "contact-type" => $contact_type,
636 "generation" => $generation];
639 $gcontact = GContact::sanitize($gcontact);
640 GContact::update($gcontact);
641 } catch (Exception $e) {
642 Logger::log($e->getMessage(), Logger::DEBUG);
645 Logger::log("Done for profile ".$profile_url, Logger::DEBUG);