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));
223 * @brief Returns a list of all known servers
224 * @return array List of server urls
227 public static function serverlist()
230 "SELECT `url`, `site_name` AS `displayName`, `network`, `platform`, `version` FROM `gserver`
231 WHERE `network` IN ('%s', '%s', '%s') AND `last_contact` > `last_failure`
232 ORDER BY `last_contact`
234 DBA::escape(Protocol::DFRN),
235 DBA::escape(Protocol::DIASPORA),
236 DBA::escape(Protocol::OSTATUS)
239 if (!DBA::isResult($r)) {
247 * @brief Fetch server list from remote servers and adds them when they are new.
249 * @param string $poco URL to the POCO endpoint
250 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
252 private static function fetchServerlist($poco)
254 $curlResult = Network::curl($poco . "/@server");
256 if (!$curlResult->isSuccess()) {
260 $serverlist = json_decode($curlResult->getBody(), true);
262 if (!is_array($serverlist)) {
266 foreach ($serverlist as $server) {
267 $server_url = str_replace("/index.php", "", $server['url']);
269 $r = q("SELECT `nurl` FROM `gserver` WHERE `nurl` = '%s'", DBA::escape(Strings::normaliseLink($server_url)));
271 if (!DBA::isResult($r)) {
272 Logger::log("Call server check for server ".$server_url, Logger::DEBUG);
273 Worker::add(PRIORITY_LOW, 'CheckServer', $server_url);
278 private static function discoverFederation()
280 $last = Config::get('poco', 'last_federation_discovery');
283 $next = $last + (24 * 60 * 60);
285 if ($next > time()) {
290 // Discover Friendica, Hubzilla and Diaspora servers
291 $curlResult = Network::fetchUrl("http://the-federation.info/pods.json");
293 if (!empty($curlResult)) {
294 $servers = json_decode($curlResult, true);
296 if (!empty($servers['pods'])) {
297 foreach ($servers['pods'] as $server) {
298 Worker::add(PRIORITY_LOW, 'CheckServer', 'https://' . $server['host']);
303 // Disvover Mastodon servers
304 if (!Config::get('system', 'ostatus_disabled')) {
305 $accesstoken = Config::get('system', 'instances_social_key');
307 if (!empty($accesstoken)) {
308 $api = 'https://instances.social/api/1.0/instances/list?count=0';
309 $header = ['Authorization: Bearer '.$accesstoken];
310 $curlResult = Network::curl($api, false, ['headers' => $header]);
312 if ($curlResult->isSuccess()) {
313 $servers = json_decode($curlResult->getBody(), true);
315 foreach ($servers['instances'] as $server) {
316 $url = (is_null($server['https_score']) ? 'http' : 'https') . '://' . $server['name'];
317 Worker::add(PRIORITY_LOW, 'CheckServer', $url);
323 // Currently disabled, since the service isn't available anymore.
324 // It is not removed since I hope that there will be a successor.
325 // Discover GNU Social Servers.
326 //if (!Config::get('system','ostatus_disabled')) {
327 // $serverdata = "http://gstools.org/api/get_open_instances/";
329 // $curlResult = Network::curl($serverdata);
330 // if ($curlResult->isSuccess()) {
331 // $servers = json_decode($result->getBody(), true);
333 // foreach($servers['data'] as $server)
334 // GServer::check($server['instance_address']);
338 Config::set('poco', 'last_federation_discovery', time());
341 public static function discoverSingleServer($id)
343 $server = DBA::selectFirst('gserver', ['poco', 'nurl', 'url', 'network'], ['id' => $id]);
345 if (!DBA::isResult($server)) {
349 // Discover new servers out there (Works from Friendica version 3.5.2)
350 self::fetchServerlist($server["poco"]);
352 // Fetch all users from the other server
353 $url = $server["poco"] . "/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
355 Logger::info("Fetch all users from the server " . $server["url"]);
357 $curlResult = Network::curl($url);
359 if ($curlResult->isSuccess() && !empty($curlResult->getBody())) {
360 $data = json_decode($curlResult->getBody(), true);
363 self::discoverServer($data, 2);
366 if (Config::get('system', 'poco_discovery') >= self::USERS_GCONTACTS) {
367 $timeframe = Config::get('system', 'poco_discovery_since');
369 if ($timeframe == 0) {
373 $updatedSince = date(DateTimeFormat::MYSQL, time() - $timeframe * 86400);
375 // Fetch all global contacts from the other server (Not working with Redmatrix and Friendica versions before 3.3)
376 $url = $server["poco"]."/@global?updatedSince=".$updatedSince."&fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation";
380 $curlResult = Network::curl($url);
382 if ($curlResult->isSuccess() && !empty($curlResult->getBody())) {
383 Logger::info("Fetch all global contacts from the server " . $server["nurl"]);
384 $data = json_decode($curlResult->getBody(), true);
387 $success = self::discoverServer($data);
391 if (!$success && !empty($data) && Config::get('system', 'poco_discovery') >= self::USERS_GCONTACTS_FALLBACK) {
392 Logger::info("Fetch contacts from users of the server " . $server["nurl"]);
393 self::discoverServerUsers($data, $server);
397 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
398 DBA::update('gserver', $fields, ['nurl' => $server["nurl"]]);
402 // If the server hadn't replied correctly, then force a sanity check
403 GServer::check($server["url"], $server["network"], true);
405 // If we couldn't reach the server, we will try it some time later
406 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
407 DBA::update('gserver', $fields, ['nurl' => $server["nurl"]]);
413 public static function discover($complete = false)
415 // Update the server list
416 self::discoverFederation();
420 $requery_days = intval(Config::get('system', 'poco_requery_days'));
422 if ($requery_days == 0) {
426 $last_update = date('c', time() - (60 * 60 * 24 * $requery_days));
428 $gservers = q("SELECT `id`, `url`, `nurl`, `network`, `poco`
430 WHERE `last_contact` >= `last_failure`
432 AND `last_poco_query` < '%s'
433 ORDER BY RAND()", DBA::escape($last_update)
436 if (DBA::isResult($gservers)) {
437 foreach ($gservers as $gserver) {
438 if (!GServer::check($gserver['url'], $gserver['network'])) {
439 // The server is not reachable? Okay, then we will try it later
440 $fields = ['last_poco_query' => DateTimeFormat::utcNow()];
441 DBA::update('gserver', $fields, ['nurl' => $gserver['nurl']]);
445 Logger::log('Update directory from server ' . $gserver['url'] . ' with ID ' . $gserver['id'], Logger::DEBUG);
446 Worker::add(PRIORITY_LOW, 'UpdateServerDirectory', $gserver);
448 if (!$complete && ( --$no_of_queries == 0)) {
455 private static function discoverServerUsers(array $data, array $server)
457 if (!isset($data['entry'])) {
461 foreach ($data['entry'] as $entry) {
464 if (isset($entry['urls'])) {
465 foreach ($entry['urls'] as $url) {
466 if ($url['type'] == 'profile') {
467 $profile_url = $url['value'];
468 $path_array = explode('/', parse_url($profile_url, PHP_URL_PATH));
469 $username = end($path_array);
474 if ($username != '') {
475 Logger::log('Fetch contacts for the user ' . $username . ' from the server ' . $server['nurl'], Logger::DEBUG);
477 // Fetch all contacts from a given user from the other server
478 $url = $server['poco'] . '/' . $username . '/?fields=displayName,urls,photos,updated,network,aboutMe,currentLocation,tags,gender,contactType,generation';
480 $curlResult = Network::curl($url);
482 if ($curlResult->isSuccess()) {
483 $data = json_decode($curlResult->getBody(), true);
486 self::discoverServer($data, 3);
493 private static function discoverServer(array $data, $default_generation = 0)
495 if (empty($data['entry'])) {
501 foreach ($data['entry'] as $entry) {
507 $updated = DBA::NULL_DATETIME;
513 $generation = $default_generation;
515 if (!empty($entry['displayName'])) {
516 $name = $entry['displayName'];
519 if (isset($entry['urls'])) {
520 foreach ($entry['urls'] as $url) {
521 if ($url['type'] == 'profile') {
522 $profile_url = $url['value'];
525 if ($url['type'] == 'webfinger') {
526 $connect_url = str_replace('acct:' , '', $url['value']);
532 if (isset($entry['photos'])) {
533 foreach ($entry['photos'] as $photo) {
534 if ($photo['type'] == 'profile') {
535 $profile_photo = $photo['value'];
541 if (isset($entry['updated'])) {
542 $updated = date(DateTimeFormat::MYSQL, strtotime($entry['updated']));
545 if (isset($entry['network'])) {
546 $network = $entry['network'];
549 if (isset($entry['currentLocation'])) {
550 $location = $entry['currentLocation'];
553 if (isset($entry['aboutMe'])) {
554 $about = HTML::toBBCode($entry['aboutMe']);
557 if (isset($entry['gender'])) {
558 $gender = $entry['gender'];
561 if (isset($entry['generation']) && ($entry['generation'] > 0)) {
562 $generation = ++$entry['generation'];
565 if (isset($entry['contactType']) && ($entry['contactType'] >= 0)) {
566 $contact_type = $entry['contactType'];
569 if (isset($entry['tags'])) {
570 foreach ($entry['tags'] as $tag) {
571 $keywords = implode(", ", $tag);
575 if ($generation > 0) {
578 Logger::log("Store profile ".$profile_url, Logger::DEBUG);
580 $gcontact = ["url" => $profile_url,
582 "network" => $network,
583 "photo" => $profile_photo,
585 "location" => $location,
587 "keywords" => $keywords,
588 "connect" => $connect_url,
589 "updated" => $updated,
590 "contact-type" => $contact_type,
591 "generation" => $generation];
594 $gcontact = GContact::sanitize($gcontact);
595 GContact::update($gcontact);
596 } catch (Exception $e) {
597 Logger::log($e->getMessage(), Logger::DEBUG);
600 Logger::log("Done for profile ".$profile_url, Logger::DEBUG);