3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Model;
24 use Friendica\Content\Text\HTML;
25 use Friendica\Core\Cache\Enum\Duration;
26 use Friendica\Core\Logger;
27 use Friendica\Core\System;
28 use Friendica\Database\DBA;
30 use Friendica\Network\HTTPClient\Client\HttpClientAccept;
31 use Friendica\Network\HTTPException;
32 use Friendica\Network\Probe;
33 use Friendica\Protocol\ActivityNamespace;
34 use Friendica\Protocol\ActivityPub;
35 use Friendica\Protocol\ActivityPub\Transmitter;
36 use Friendica\Util\Crypto;
37 use Friendica\Util\DateTimeFormat;
38 use Friendica\Util\HTTPSignature;
39 use Friendica\Util\JsonLD;
40 use Friendica\Util\Network;
41 use GuzzleHttp\Psr7\Uri;
46 * Fetch webfinger data
48 * @param string $addr Address
49 * @return array webfinger data
51 private static function fetchWebfingerData(string $addr): array
53 $addr_parts = explode('@', $addr);
54 if (count($addr_parts) != 2) {
58 if (Contact::isLocal($addr) && ($local_uid = User::getIdForURL($addr)) && ($local_owner = User::getOwnerDataById($local_uid))) {
60 'addr' => $local_owner['addr'],
61 'baseurl' => $local_owner['baseurl'],
62 'url' => $local_owner['url'],
63 'subscribe' => $local_owner['baseurl'] . '/follow?url={uri}'];
65 if (!empty($local_owner['alias']) && ($local_owner['url'] != $local_owner['alias'])) {
66 $data['alias'] = $local_owner['alias'];
72 $data = ['addr' => $addr];
73 $template = 'https://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
74 $webfinger = Probe::webfinger(str_replace('{uri}', urlencode($addr), $template), HttpClientAccept::JRD_JSON);
75 if (empty($webfinger['links'])) {
76 $template = 'http://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
77 $webfinger = Probe::webfinger(str_replace('{uri}', urlencode($addr), $template), HttpClientAccept::JRD_JSON);
78 if (empty($webfinger['links'])) {
81 $data['baseurl'] = 'http://' . $addr_parts[1];
83 $data['baseurl'] = 'https://' . $addr_parts[1];
86 foreach ($webfinger['links'] as $link) {
87 if (empty($link['rel'])) {
91 if (!empty($link['template']) && ($link['rel'] == ActivityNamespace::OSTATUSSUB)) {
92 $data['subscribe'] = $link['template'];
95 if (!empty($link['href']) && !empty($link['type']) && ($link['rel'] == 'self') && ($link['type'] == 'application/activity+json')) {
96 $data['url'] = $link['href'];
99 if (!empty($link['href']) && !empty($link['type']) && ($link['rel'] == 'http://webfinger.net/rel/profile-page') && ($link['type'] == 'text/html')) {
100 $data['alias'] = $link['href'];
104 if (!empty($data['url']) && !empty($data['alias']) && ($data['url'] == $data['alias'])) {
105 unset($data['alias']);
112 * Fetches a profile from a given url
114 * @param string $url profile url
115 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
116 * @return array profile array
117 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
118 * @throws \ImagickException
119 * @todo Rewrite parameter $update to avoid true|false|null (boolean is binary, null adds a third case)
121 public static function getByURL(string $url, $update = null): array
123 if (empty($url) || Network::isUrlBlocked($url)) {
124 Logger::info('Domain is blocked', ['url' => $url]);
128 $fetched_contact = [];
130 if (empty($update)) {
131 if (is_null($update)) {
132 $ref_update = DateTimeFormat::utc('now - 1 month');
134 $ref_update = DBA::NULL_DATETIME;
137 $apcontact = DBA::selectFirst('apcontact', [], ['url' => $url]);
138 if (!DBA::isResult($apcontact)) {
139 $apcontact = DBA::selectFirst('apcontact', [], ['alias' => $url]);
142 if (!DBA::isResult($apcontact)) {
143 $apcontact = DBA::selectFirst('apcontact', [], ['addr' => $url]);
146 if (DBA::isResult($apcontact) && ($apcontact['updated'] > $ref_update) && !empty($apcontact['pubkey']) && !empty($apcontact['uri-id'])) {
150 if (!is_null($update)) {
151 return DBA::isResult($apcontact) ? $apcontact : [];
154 if (DBA::isResult($apcontact)) {
155 $fetched_contact = $apcontact;
161 $webfinger = empty(parse_url($url, PHP_URL_SCHEME));
163 $apcontact = self::fetchWebfingerData($url);
164 if (empty($apcontact['url'])) {
165 return $fetched_contact;
167 $url = $apcontact['url'];
168 } elseif (empty(parse_url($url, PHP_URL_PATH))) {
169 $apcontact['baseurl'] = $url;
172 // Detect multiple fast repeating request to the same address
173 // See https://github.com/friendica/friendica/issues/9303
174 $cachekey = 'apcontact:' . ItemURI::getIdByURI($url);
175 $result = DI::cache()->get($cachekey);
176 if (!is_null($result)) {
177 Logger::notice('Multiple requests for the address', ['url' => $url, 'update' => $update, 'callstack' => System::callstack(20), 'result' => $result]);
178 if (!empty($fetched_contact)) {
179 return $fetched_contact;
182 DI::cache()->set($cachekey, System::callstack(20), Duration::FIVE_MINUTES);
185 if (Network::isLocalLink($url) && ($local_uid = User::getIdForURL($url))) {
187 $data = Transmitter::getProfile($local_uid);
188 $local_owner = User::getOwnerDataById($local_uid);
189 } catch(HTTPException\NotFoundException $e) {
197 $curlResult = HTTPSignature::fetchRaw($url);
198 $failed = empty($curlResult) || empty($curlResult->getBody()) ||
199 (!$curlResult->isSuccess() && ($curlResult->getReturnCode() != 410));
202 $data = json_decode($curlResult->getBody(), true);
203 $failed = empty($data) || !is_array($data);
206 if (!$failed && ($curlResult->getReturnCode() == 410)) {
207 $data = ['@context' => ActivityPub::CONTEXT, 'id' => $url, 'type' => 'Tombstone'];
211 self::markForArchival($fetched_contact ?: []);
212 return $fetched_contact;
216 $compacted = JsonLD::compact($data);
217 if (empty($compacted['@id'])) {
218 return $fetched_contact;
221 $apcontact['url'] = $compacted['@id'];
222 $apcontact['uuid'] = JsonLD::fetchElement($compacted, 'diaspora:guid', '@value');
223 $apcontact['type'] = str_replace('as:', '', JsonLD::fetchElement($compacted, '@type'));
224 $apcontact['following'] = JsonLD::fetchElement($compacted, 'as:following', '@id');
225 $apcontact['followers'] = JsonLD::fetchElement($compacted, 'as:followers', '@id');
226 $apcontact['inbox'] = (JsonLD::fetchElement($compacted, 'ldp:inbox', '@id') ?? '');
227 self::unarchiveInbox($apcontact['inbox'], false);
229 $apcontact['outbox'] = JsonLD::fetchElement($compacted, 'as:outbox', '@id');
231 $apcontact['sharedinbox'] = '';
232 if (!empty($compacted['as:endpoints'])) {
233 $apcontact['sharedinbox'] = (JsonLD::fetchElement($compacted['as:endpoints'], 'as:sharedInbox', '@id') ?? '');
234 self::unarchiveInbox($apcontact['sharedinbox'], true);
237 $apcontact['featured'] = JsonLD::fetchElement($compacted, 'toot:featured', '@id');
238 $apcontact['featured-tags'] = JsonLD::fetchElement($compacted, 'toot:featuredTags', '@id');
240 $apcontact['nick'] = JsonLD::fetchElement($compacted, 'as:preferredUsername', '@value') ?? '';
241 $apcontact['name'] = JsonLD::fetchElement($compacted, 'as:name', '@value');
243 if (empty($apcontact['name'])) {
244 $apcontact['name'] = $apcontact['nick'];
247 $apcontact['about'] = HTML::toBBCode(JsonLD::fetchElement($compacted, 'as:summary', '@value') ?? '');
249 $ims = JsonLD::fetchElementArray($compacted, 'vcard:hasInstantMessage');
252 foreach ($ims as $link) {
253 if (substr($link, 0, 5) == 'xmpp:') {
254 $apcontact['xmpp'] = substr($link, 5);
256 if (substr($link, 0, 7) == 'matrix:') {
257 $apcontact['matrix'] = substr($link, 7);
262 $apcontact['photo'] = JsonLD::fetchElement($compacted, 'as:icon', '@id');
263 if (is_array($apcontact['photo']) || !empty($compacted['as:icon']['as:url']['@id'])) {
264 $apcontact['photo'] = JsonLD::fetchElement($compacted['as:icon'], 'as:url', '@id');
267 $apcontact['header'] = JsonLD::fetchElement($compacted, 'as:image', '@id');
268 if (is_array($apcontact['header']) || !empty($compacted['as:image']['as:url']['@id'])) {
269 $apcontact['header'] = JsonLD::fetchElement($compacted['as:image'], 'as:url', '@id');
272 if (empty($apcontact['alias'])) {
273 $apcontact['alias'] = JsonLD::fetchElement($compacted, 'as:url', '@id');
274 if (is_array($apcontact['alias'])) {
275 $apcontact['alias'] = JsonLD::fetchElement($compacted['as:url'], 'as:href', '@id');
279 // Quit if none of the basic values are set
280 if (empty($apcontact['url']) || empty($apcontact['type']) || (($apcontact['type'] != 'Tombstone') && empty($apcontact['inbox']))) {
281 return $fetched_contact;
282 } elseif ($apcontact['type'] == 'Tombstone') {
283 // The "inbox" field must have a content
284 $apcontact['inbox'] = '';
287 // Quit if this doesn't seem to be an account at all
288 if (!in_array($apcontact['type'], ActivityPub::ACCOUNT_TYPES)) {
289 return $fetched_contact;
292 $parts = parse_url($apcontact['url']);
293 unset($parts['scheme']);
294 unset($parts['path']);
296 if (empty($apcontact['addr'])) {
297 if (!empty($apcontact['nick']) && is_array($parts)) {
298 $apcontact['addr'] = $apcontact['nick'] . '@' . str_replace('//', '', Network::unparseURL($parts));
300 $apcontact['addr'] = '';
304 $apcontact['pubkey'] = null;
305 if (!empty($compacted['w3id:publicKey'])) {
306 $apcontact['pubkey'] = trim(JsonLD::fetchElement($compacted['w3id:publicKey'], 'w3id:publicKeyPem', '@value'));
307 if (strstr($apcontact['pubkey'], 'RSA ')) {
308 $apcontact['pubkey'] = Crypto::rsaToPem($apcontact['pubkey']);
312 $apcontact['manually-approve'] = (int)JsonLD::fetchElement($compacted, 'as:manuallyApprovesFollowers');
314 $apcontact['suspended'] = (int)JsonLD::fetchElement($compacted, 'toot:suspended');
316 if (!empty($compacted['as:generator'])) {
317 $apcontact['baseurl'] = JsonLD::fetchElement($compacted['as:generator'], 'as:url', '@id');
318 $apcontact['generator'] = JsonLD::fetchElement($compacted['as:generator'], 'as:name', '@value');
321 if (!empty($apcontact['following'])) {
322 if (!empty($local_owner)) {
323 $following = ActivityPub\Transmitter::getContacts($local_owner, [Contact::SHARING, Contact::FRIEND], 'following');
325 $following = ActivityPub::fetchContent($apcontact['following']);
327 if (!empty($following['totalItems'])) {
328 // Mastodon seriously allows for this condition?
329 // Jul 14 2021 - See https://mastodon.social/@BLUW for a negative following count
330 if ($following['totalItems'] < 0) {
331 $following['totalItems'] = 0;
333 $apcontact['following_count'] = $following['totalItems'];
337 if (!empty($apcontact['followers'])) {
338 if (!empty($local_owner)) {
339 $followers = ActivityPub\Transmitter::getContacts($local_owner, [Contact::FOLLOWER, Contact::FRIEND], 'followers');
341 $followers = ActivityPub::fetchContent($apcontact['followers']);
343 if (!empty($followers['totalItems'])) {
344 // Mastodon seriously allows for this condition?
345 // Jul 14 2021 - See https://mastodon.online/@goes11 for a negative followers count
346 if ($followers['totalItems'] < 0) {
347 $followers['totalItems'] = 0;
349 $apcontact['followers_count'] = $followers['totalItems'];
353 if (!empty($apcontact['outbox'])) {
354 if (!empty($local_owner)) {
355 $outbox = ActivityPub\Transmitter::getOutbox($local_owner);
357 $outbox = ActivityPub::fetchContent($apcontact['outbox']);
359 if (!empty($outbox['totalItems'])) {
360 // Mastodon seriously allows for this condition?
361 // Jul 20 2021 - See https://chaos.social/@m11 for a negative posts count
362 if ($outbox['totalItems'] < 0) {
363 $outbox['totalItems'] = 0;
365 $apcontact['statuses_count'] = $outbox['totalItems'];
369 $apcontact['discoverable'] = JsonLD::fetchElement($compacted, 'toot:discoverable', '@value');
374 // tag, attachment, image, nomadicLocations, signature, movedTo, liked
376 // Unhandled from Misskey
377 // sharedInbox, isCat
379 // Unhandled from Kroeg
380 // kroeg:blocks, updated
382 // When the photo is too large, try to shorten it by removing parts
383 if (strlen($apcontact['photo']) > 255) {
384 $parts = parse_url($apcontact['photo']);
385 unset($parts['fragment']);
386 $apcontact['photo'] = (string)Uri::fromParts($parts);
388 if (strlen($apcontact['photo']) > 255) {
389 unset($parts['query']);
390 $apcontact['photo'] = (string)Uri::fromParts($parts);
393 if (strlen($apcontact['photo']) > 255) {
394 $apcontact['photo'] = substr($apcontact['photo'], 0, 255);
398 if (!$webfinger && !empty($apcontact['addr'])) {
399 $data = self::fetchWebfingerData($apcontact['addr']);
401 $apcontact['baseurl'] = $data['baseurl'];
403 if (empty($apcontact['alias']) && !empty($data['alias'])) {
404 $apcontact['alias'] = $data['alias'];
406 if (!empty($data['subscribe'])) {
407 $apcontact['subscribe'] = $data['subscribe'];
410 $apcontact['addr'] = null;
414 if (empty($apcontact['baseurl'])) {
415 $apcontact['baseurl'] = null;
418 if (empty($apcontact['subscribe'])) {
419 $apcontact['subscribe'] = null;
422 if (!empty($apcontact['baseurl']) && empty($fetched_contact['gsid'])) {
423 $apcontact['gsid'] = GServer::getID($apcontact['baseurl']);
424 } elseif (!empty($fetched_contact['gsid'])) {
425 $apcontact['gsid'] = $fetched_contact['gsid'];
427 $apcontact['gsid'] = null;
430 if ($apcontact['url'] == $apcontact['alias']) {
431 $apcontact['alias'] = null;
434 if (empty($apcontact['uuid'])) {
435 $apcontact['uri-id'] = ItemURI::getIdByURI($apcontact['url']);
437 $apcontact['uri-id'] = ItemURI::insert(['uri' => $apcontact['url'], 'guid' => $apcontact['uuid']]);
440 foreach (APContact\Endpoint::ENDPOINT_NAMES as $type => $name) {
441 $value = JsonLD::fetchElement($compacted, $name, '@id');
445 APContact\Endpoint::update($apcontact['uri-id'], $type, $value);
448 if (!empty($compacted['as:endpoints'])) {
449 foreach ($compacted['as:endpoints'] as $name => $endpoint) {
450 if (empty($endpoint['@id']) || !is_string($endpoint['@id'])) {
454 if (in_array($name, APContact\Endpoint::ENDPOINT_NAMES)) {
455 $key = array_search($name, APContact\Endpoint::ENDPOINT_NAMES);
456 APContact\Endpoint::update($apcontact['uri-id'], $key, $endpoint['@id']);
457 Logger::debug('Store endpoint', ['key' => $key, 'name' => $name, 'endpoint' => $endpoint['@id']]);
458 } elseif (!in_array($name, ['as:sharedInbox', 'as:uploadMedia', 'as:oauthTokenEndpoint', 'as:oauthAuthorizationEndpoint', 'litepub:oauthRegistrationEndpoint'])) {
459 Logger::debug('Unknown endpoint', ['name' => $name, 'endpoint' => $endpoint['@id']]);
464 $apcontact['updated'] = DateTimeFormat::utcNow();
466 // We delete the old entry when the URL is changed
467 if ($url != $apcontact['url']) {
468 Logger::info('Delete changed profile url', ['old' => $url, 'new' => $apcontact['url']]);
469 DBA::delete('apcontact', ['url' => $url]);
472 // Limit the length on incoming fields
473 $apcontact = DI::dbaDefinition()->truncateFieldsForTable('apcontact', $apcontact);
475 if (DBA::exists('apcontact', ['url' => $apcontact['url']])) {
476 DBA::update('apcontact', $apcontact, ['url' => $apcontact['url']]);
478 DBA::replace('apcontact', $apcontact);
481 Logger::info('Updated profile', ['url' => $url]);
483 return DBA::selectFirst('apcontact', [], ['url' => $apcontact['url']]) ?: [];
487 * Mark the given AP Contact as "to archive"
489 * @param array $apcontact
492 public static function markForArchival(array $apcontact)
494 if (!empty($apcontact['inbox'])) {
495 Logger::info('Set inbox status to failure', ['inbox' => $apcontact['inbox']]);
496 HTTPSignature::setInboxStatus($apcontact['inbox'], false);
499 if (!empty($apcontact['sharedinbox'])) {
500 // Check if there are any available inboxes
501 $available = DBA::exists('apcontact', ["`sharedinbox` = ? AnD `inbox` IN (SELECT `url` FROM `inbox-status` WHERE `success` > `failure`)",
502 $apcontact['sharedinbox']]);
504 // If all known personal inboxes are failing then set their shared inbox to failure as well
505 Logger::info('Set shared inbox status to failure', ['sharedinbox' => $apcontact['sharedinbox']]);
506 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], false, true);
512 * Unmark the given AP Contact as "to archive"
514 * @param array $apcontact
517 public static function unmarkForArchival(array $apcontact)
519 if (!empty($apcontact['inbox'])) {
520 Logger::info('Set inbox status to success', ['inbox' => $apcontact['inbox']]);
521 HTTPSignature::setInboxStatus($apcontact['inbox'], true);
523 if (!empty($apcontact['sharedinbox'])) {
524 Logger::info('Set shared inbox status to success', ['sharedinbox' => $apcontact['sharedinbox']]);
525 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], true, true);
532 * @param string $url inbox url
533 * @param boolean $shared Shared Inbox
536 private static function unarchiveInbox(string $url, bool $shared)
542 HTTPSignature::setInboxStatus($url, true, $shared);
546 * Check if the apcontact is a relay account
548 * @param array $apcontact
552 public static function isRelay(array $apcontact): bool
554 if ($apcontact['nick'] != 'relay') {
558 if ($apcontact['type'] == 'Application') {
562 if (in_array($apcontact['type'], ['Group', 'Service']) && is_null($apcontact['outbox'])) {