3 * @copyright Copyright (C) 2010-2021, 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\Duration;
26 use Friendica\Core\Logger;
27 use Friendica\Core\System;
28 use Friendica\Database\DBA;
29 use Friendica\Database\DBStructure;
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 Friendica\Util\Strings;
46 * Fetch webfinger data
48 * @param string $addr Address
49 * @return array webfinger data
51 private static function fetchWebfingerData(string $addr)
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), 'application/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), 'application/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
120 public static function getByURL($url, $update = null)
126 $fetched_contact = false;
128 if (empty($update)) {
129 if (is_null($update)) {
130 $ref_update = DateTimeFormat::utc('now - 1 month');
132 $ref_update = DBA::NULL_DATETIME;
135 $apcontact = DBA::selectFirst('apcontact', [], ['url' => $url]);
136 if (!DBA::isResult($apcontact)) {
137 $apcontact = DBA::selectFirst('apcontact', [], ['alias' => $url]);
140 if (!DBA::isResult($apcontact)) {
141 $apcontact = DBA::selectFirst('apcontact', [], ['addr' => $url]);
144 if (DBA::isResult($apcontact) && ($apcontact['updated'] > $ref_update) && !empty($apcontact['pubkey']) && !empty($apcontact['uri-id'])) {
148 if (!is_null($update)) {
149 return DBA::isResult($apcontact) ? $apcontact : [];
152 if (DBA::isResult($apcontact)) {
153 $fetched_contact = $apcontact;
159 $webfinger = empty(parse_url($url, PHP_URL_SCHEME));
161 $apcontact = self::fetchWebfingerData($url);
162 if (empty($apcontact['url'])) {
163 return $fetched_contact;
165 $url = $apcontact['url'];
168 // Detect multiple fast repeating request to the same address
169 // See https://github.com/friendica/friendica/issues/9303
170 $cachekey = 'apcontact:getByURL:' . $url;
171 $result = DI::cache()->get($cachekey);
172 if (!is_null($result)) {
173 Logger::notice('Multiple requests for the address', ['url' => $url, 'update' => $update, 'callstack' => System::callstack(20), 'result' => $result]);
174 if (!empty($fetched_contact)) {
175 return $fetched_contact;
178 DI::cache()->set($cachekey, System::callstack(20), Duration::FIVE_MINUTES);
181 if (Network::isLocalLink($url) && ($local_uid = User::getIdForURL($url))) {
183 $data = Transmitter::getProfile($local_uid);
184 $local_owner = User::getOwnerDataById($local_uid);
185 } catch(HTTPException\NotFoundException $e) {
193 $curlResult = HTTPSignature::fetchRaw($url);
194 $failed = empty($curlResult) || empty($curlResult->getBody()) ||
195 (!$curlResult->isSuccess() && ($curlResult->getReturnCode() != 410));
198 $data = json_decode($curlResult->getBody(), true);
199 $failed = empty($data) || !is_array($data);
202 if (!$failed && ($curlResult->getReturnCode() == 410)) {
203 $data = ['@context' => ActivityPub::CONTEXT, 'id' => $url, 'type' => 'Tombstone'];
207 self::markForArchival($fetched_contact ?: []);
208 return $fetched_contact;
212 $compacted = JsonLD::compact($data);
213 if (empty($compacted['@id'])) {
214 return $fetched_contact;
217 $apcontact['url'] = $compacted['@id'];
218 $apcontact['uuid'] = JsonLD::fetchElement($compacted, 'diaspora:guid', '@value');
219 $apcontact['type'] = str_replace('as:', '', JsonLD::fetchElement($compacted, '@type'));
220 $apcontact['following'] = JsonLD::fetchElement($compacted, 'as:following', '@id');
221 $apcontact['followers'] = JsonLD::fetchElement($compacted, 'as:followers', '@id');
222 $apcontact['inbox'] = JsonLD::fetchElement($compacted, 'ldp:inbox', '@id');
223 self::unarchiveInbox($apcontact['inbox'], false);
225 $apcontact['outbox'] = JsonLD::fetchElement($compacted, 'as:outbox', '@id');
227 $apcontact['sharedinbox'] = '';
228 if (!empty($compacted['as:endpoints'])) {
229 $apcontact['sharedinbox'] = JsonLD::fetchElement($compacted['as:endpoints'], 'as:sharedInbox', '@id');
230 self::unarchiveInbox($apcontact['sharedinbox'], true);
233 $apcontact['nick'] = JsonLD::fetchElement($compacted, 'as:preferredUsername', '@value') ?? '';
234 $apcontact['name'] = JsonLD::fetchElement($compacted, 'as:name', '@value');
236 if (empty($apcontact['name'])) {
237 $apcontact['name'] = $apcontact['nick'];
240 $apcontact['about'] = HTML::toBBCode(JsonLD::fetchElement($compacted, 'as:summary', '@value'));
242 $apcontact['photo'] = JsonLD::fetchElement($compacted, 'as:icon', '@id');
243 if (is_array($apcontact['photo']) || !empty($compacted['as:icon']['as:url']['@id'])) {
244 $apcontact['photo'] = JsonLD::fetchElement($compacted['as:icon'], 'as:url', '@id');
247 $apcontact['header'] = JsonLD::fetchElement($compacted, 'as:image', '@id');
248 if (is_array($apcontact['header']) || !empty($compacted['as:image']['as:url']['@id'])) {
249 $apcontact['header'] = JsonLD::fetchElement($compacted['as:image'], 'as:url', '@id');
252 if (empty($apcontact['alias'])) {
253 $apcontact['alias'] = JsonLD::fetchElement($compacted, 'as:url', '@id');
254 if (is_array($apcontact['alias'])) {
255 $apcontact['alias'] = JsonLD::fetchElement($compacted['as:url'], 'as:href', '@id');
259 // Quit if none of the basic values are set
260 if (empty($apcontact['url']) || empty($apcontact['type']) || (($apcontact['type'] != 'Tombstone') && empty($apcontact['inbox']))) {
261 return $fetched_contact;
262 } elseif ($apcontact['type'] == 'Tombstone') {
263 // The "inbox" field must have a content
264 $apcontact['inbox'] = '';
267 // Quit if this doesn't seem to be an account at all
268 if (!in_array($apcontact['type'], ActivityPub::ACCOUNT_TYPES)) {
269 return $fetched_contact;
272 $parts = parse_url($apcontact['url']);
273 unset($parts['scheme']);
274 unset($parts['path']);
276 if (empty($apcontact['addr'])) {
277 if (!empty($apcontact['nick']) && is_array($parts)) {
278 $apcontact['addr'] = $apcontact['nick'] . '@' . str_replace('//', '', Network::unparseURL($parts));
280 $apcontact['addr'] = '';
284 $apcontact['pubkey'] = null;
285 if (!empty($compacted['w3id:publicKey'])) {
286 $apcontact['pubkey'] = trim(JsonLD::fetchElement($compacted['w3id:publicKey'], 'w3id:publicKeyPem', '@value'));
287 if (strstr($apcontact['pubkey'], 'RSA ')) {
288 $apcontact['pubkey'] = Crypto::rsaToPem($apcontact['pubkey']);
292 $apcontact['manually-approve'] = (int)JsonLD::fetchElement($compacted, 'as:manuallyApprovesFollowers');
294 if (!empty($compacted['as:generator'])) {
295 $apcontact['baseurl'] = JsonLD::fetchElement($compacted['as:generator'], 'as:url', '@id');
296 $apcontact['generator'] = JsonLD::fetchElement($compacted['as:generator'], 'as:name', '@value');
299 if (!empty($apcontact['following'])) {
300 if (!empty($local_owner)) {
301 $following = ActivityPub\Transmitter::getContacts($local_owner, [Contact::SHARING, Contact::FRIEND], 'following');
303 $following = ActivityPub::fetchContent($apcontact['following']);
305 if (!empty($following['totalItems'])) {
306 // Mastodon seriously allows for this condition?
307 // Jul 14 2021 - See https://mastodon.social/@BLUW for a negative following count
308 if ($following['totalItems'] < 0) {
309 $following['totalItems'] = 0;
311 $apcontact['following_count'] = $following['totalItems'];
315 if (!empty($apcontact['followers'])) {
316 if (!empty($local_owner)) {
317 $followers = ActivityPub\Transmitter::getContacts($local_owner, [Contact::FOLLOWER, Contact::FRIEND], 'followers');
319 $followers = ActivityPub::fetchContent($apcontact['followers']);
321 if (!empty($followers['totalItems'])) {
322 // Mastodon seriously allows for this condition?
323 // Jul 14 2021 - See https://mastodon.online/@goes11 for a negative followers count
324 if ($followers['totalItems'] < 0) {
325 $followers['totalItems'] = 0;
327 $apcontact['followers_count'] = $followers['totalItems'];
331 if (!empty($apcontact['outbox'])) {
332 if (!empty($local_owner)) {
333 $outbox = ActivityPub\Transmitter::getOutbox($local_owner);
335 $outbox = ActivityPub::fetchContent($apcontact['outbox']);
337 if (!empty($outbox['totalItems'])) {
338 // Mastodon seriously allows for this condition?
339 // Jul 20 2021 - See https://chaos.social/@m11 for a negative posts count
340 if ($outbox['totalItems'] < 0) {
341 $outbox['totalItems'] = 0;
343 $apcontact['statuses_count'] = $outbox['totalItems'];
347 $apcontact['discoverable'] = JsonLD::fetchElement($compacted, 'toot:discoverable', '@value');
352 // tag, attachment, image, nomadicLocations, signature, featured, movedTo, liked
354 // Unhandled from Misskey
355 // sharedInbox, isCat
357 // Unhandled from Kroeg
358 // kroeg:blocks, updated
360 // When the photo is too large, try to shorten it by removing parts
361 if (strlen($apcontact['photo']) > 255) {
362 $parts = parse_url($apcontact['photo']);
363 unset($parts['fragment']);
364 $apcontact['photo'] = Network::unparseURL($parts);
366 if (strlen($apcontact['photo']) > 255) {
367 unset($parts['query']);
368 $apcontact['photo'] = Network::unparseURL($parts);
371 if (strlen($apcontact['photo']) > 255) {
372 $apcontact['photo'] = substr($apcontact['photo'], 0, 255);
376 if (!$webfinger && !empty($apcontact['addr'])) {
377 $data = self::fetchWebfingerData($apcontact['addr']);
379 $apcontact['baseurl'] = $data['baseurl'];
381 if (empty($apcontact['alias']) && !empty($data['alias'])) {
382 $apcontact['alias'] = $data['alias'];
384 if (!empty($data['subscribe'])) {
385 $apcontact['subscribe'] = $data['subscribe'];
388 $apcontact['addr'] = null;
392 if (empty($apcontact['baseurl'])) {
393 $apcontact['baseurl'] = null;
396 if (empty($apcontact['subscribe'])) {
397 $apcontact['subscribe'] = null;
400 if (!empty($apcontact['baseurl']) && empty($fetched_contact['gsid'])) {
401 $apcontact['gsid'] = GServer::getID($apcontact['baseurl']);
402 } elseif (!empty($fetched_contact['gsid'])) {
403 $apcontact['gsid'] = $fetched_contact['gsid'];
405 $apcontact['gsid'] = null;
408 if ($apcontact['url'] == $apcontact['alias']) {
409 $apcontact['alias'] = null;
412 if (empty($apcontact['uuid'])) {
413 $apcontact['uri-id'] = ItemURI::getIdByURI($apcontact['url']);
415 $apcontact['uri-id'] = ItemURI::insert(['uri' => $apcontact['url'], 'guid' => $apcontact['uuid']]);
418 $apcontact['updated'] = DateTimeFormat::utcNow();
420 // We delete the old entry when the URL is changed
421 if ($url != $apcontact['url']) {
422 Logger::info('Delete changed profile url', ['old' => $url, 'new' => $apcontact['url']]);
423 DBA::delete('apcontact', ['url' => $url]);
426 // Limit the length on incoming fields
427 $apcontact = DBStructure::getFieldsForTable('apcontact', $apcontact);
429 if (DBA::exists('apcontact', ['url' => $apcontact['url']])) {
430 DBA::update('apcontact', $apcontact, ['url' => $apcontact['url']]);
432 DBA::replace('apcontact', $apcontact);
435 Logger::info('Updated profile', ['url' => $url]);
437 return DBA::selectFirst('apcontact', [], ['url' => $apcontact['url']]) ?: [];
441 * Mark the given AP Contact as "to archive"
443 * @param array $apcontact
446 public static function markForArchival(array $apcontact)
448 if (!empty($apcontact['inbox'])) {
449 Logger::info('Set inbox status to failure', ['inbox' => $apcontact['inbox']]);
450 HTTPSignature::setInboxStatus($apcontact['inbox'], false);
453 if (!empty($apcontact['sharedinbox'])) {
454 // Check if there are any available inboxes
455 $available = DBA::exists('apcontact', ["`sharedinbox` = ? AnD `inbox` IN (SELECT `url` FROM `inbox-status` WHERE `success` > `failure`)",
456 $apcontact['sharedinbox']]);
458 // If all known personal inboxes are failing then set their shared inbox to failure as well
459 Logger::info('Set shared inbox status to failure', ['sharedinbox' => $apcontact['sharedinbox']]);
460 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], false, true);
466 * Unmark the given AP Contact as "to archive"
468 * @param array $apcontact
471 public static function unmarkForArchival(array $apcontact)
473 if (!empty($apcontact['inbox'])) {
474 Logger::info('Set inbox status to success', ['inbox' => $apcontact['inbox']]);
475 HTTPSignature::setInboxStatus($apcontact['inbox'], true);
477 if (!empty($apcontact['sharedinbox'])) {
478 Logger::info('Set shared inbox status to success', ['sharedinbox' => $apcontact['sharedinbox']]);
479 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], true, true);
486 * @param string $url inbox url
487 * @param boolean $shared Shared Inbox
489 private static function unarchiveInbox($url, $shared)
495 HTTPSignature::setInboxStatus($url, true, $shared);