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\Probe;
32 use Friendica\Protocol\ActivityNamespace;
33 use Friendica\Protocol\ActivityPub;
34 use Friendica\Util\Crypto;
35 use Friendica\Util\DateTimeFormat;
36 use Friendica\Util\HTTPSignature;
37 use Friendica\Util\JsonLD;
38 use Friendica\Util\Network;
43 * Fetch webfinger data
45 * @param string $addr Address
46 * @return array webfinger data
48 private static function fetchWebfingerData(string $addr)
50 $addr_parts = explode('@', $addr);
51 if (count($addr_parts) != 2) {
55 $data = ['addr' => $addr];
56 $template = 'https://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
57 $webfinger = Probe::webfinger(str_replace('{uri}', urlencode($addr), $template), 'application/jrd+json');
58 if (empty($webfinger['links'])) {
59 $template = 'http://' . $addr_parts[1] . '/.well-known/webfinger?resource=acct:' . urlencode($addr);
60 $webfinger = Probe::webfinger(str_replace('{uri}', urlencode($addr), $template), 'application/jrd+json');
61 if (empty($webfinger['links'])) {
64 $data['baseurl'] = 'http://' . $addr_parts[1];
66 $data['baseurl'] = 'https://' . $addr_parts[1];
69 foreach ($webfinger['links'] as $link) {
70 if (empty($link['rel'])) {
74 if (!empty($link['template']) && ($link['rel'] == ActivityNamespace::OSTATUSSUB)) {
75 $data['subscribe'] = $link['template'];
78 if (!empty($link['href']) && !empty($link['type']) && ($link['rel'] == 'self') && ($link['type'] == 'application/activity+json')) {
79 $data['url'] = $link['href'];
82 if (!empty($link['href']) && !empty($link['type']) && ($link['rel'] == 'http://webfinger.net/rel/profile-page') && ($link['type'] == 'text/html')) {
83 $data['alias'] = $link['href'];
87 if (!empty($data['url']) && !empty($data['alias']) && ($data['url'] == $data['alias'])) {
88 unset($data['alias']);
95 * Fetches a profile from a given url
97 * @param string $url profile url
98 * @param boolean $update true = always update, false = never update, null = update when not found or outdated
99 * @return array profile array
100 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
101 * @throws \ImagickException
103 public static function getByURL($url, $update = null)
109 $fetched_contact = false;
111 if (empty($update)) {
112 if (is_null($update)) {
113 $ref_update = DateTimeFormat::utc('now - 1 month');
115 $ref_update = DBA::NULL_DATETIME;
118 $apcontact = DBA::selectFirst('apcontact', [], ['url' => $url]);
119 if (!DBA::isResult($apcontact)) {
120 $apcontact = DBA::selectFirst('apcontact', [], ['alias' => $url]);
123 if (!DBA::isResult($apcontact)) {
124 $apcontact = DBA::selectFirst('apcontact', [], ['addr' => $url]);
127 if (DBA::isResult($apcontact) && ($apcontact['updated'] > $ref_update) && !empty($apcontact['pubkey'])) {
131 if (!is_null($update)) {
132 return DBA::isResult($apcontact) ? $apcontact : [];
135 if (DBA::isResult($apcontact)) {
136 $fetched_contact = $apcontact;
142 $webfinger = empty(parse_url($url, PHP_URL_SCHEME));
144 $apcontact = self::fetchWebfingerData($url);
145 if (empty($apcontact['url'])) {
146 return $fetched_contact;
148 $url = $apcontact['url'];
151 $curlResult = HTTPSignature::fetchRaw($url);
152 $failed = empty($curlResult) || empty($curlResult->getBody()) ||
153 (!$curlResult->isSuccess() && ($curlResult->getReturnCode() != 410));
156 $data = json_decode($curlResult->getBody(), true);
157 $failed = empty($data) || !is_array($data);
160 if (!$failed && ($curlResult->getReturnCode() == 410)) {
161 $data = ['@context' => ActivityPub::CONTEXT, 'id' => $url, 'type' => 'Tombstone'];
165 self::markForArchival($fetched_contact ?: []);
166 return $fetched_contact;
169 $compacted = JsonLD::compact($data);
170 if (empty($compacted['@id'])) {
171 return $fetched_contact;
174 // Detect multiple fast repeating request to the same address
175 // See https://github.com/friendica/friendica/issues/9303
176 $cachekey = 'apcontact:getByURL:' . $url;
177 $result = DI::cache()->get($cachekey);
178 if (!is_null($result)) {
179 Logger::notice('Multiple requests for the address', ['url' => $url, 'update' => $update, 'callstack' => System::callstack(20), 'result' => $result]);
181 DI::cache()->set($cachekey, System::callstack(20), Duration::FIVE_MINUTES);
184 $apcontact['url'] = $compacted['@id'];
185 $apcontact['uuid'] = JsonLD::fetchElement($compacted, 'diaspora:guid', '@value');
186 $apcontact['type'] = str_replace('as:', '', JsonLD::fetchElement($compacted, '@type'));
187 $apcontact['following'] = JsonLD::fetchElement($compacted, 'as:following', '@id');
188 $apcontact['followers'] = JsonLD::fetchElement($compacted, 'as:followers', '@id');
189 $apcontact['inbox'] = JsonLD::fetchElement($compacted, 'ldp:inbox', '@id');
190 self::unarchiveInbox($apcontact['inbox'], false);
192 $apcontact['outbox'] = JsonLD::fetchElement($compacted, 'as:outbox', '@id');
194 $apcontact['sharedinbox'] = '';
195 if (!empty($compacted['as:endpoints'])) {
196 $apcontact['sharedinbox'] = JsonLD::fetchElement($compacted['as:endpoints'], 'as:sharedInbox', '@id');
197 self::unarchiveInbox($apcontact['sharedinbox'], true);
200 $apcontact['nick'] = JsonLD::fetchElement($compacted, 'as:preferredUsername', '@value') ?? '';
201 $apcontact['name'] = JsonLD::fetchElement($compacted, 'as:name', '@value');
203 if (empty($apcontact['name'])) {
204 $apcontact['name'] = $apcontact['nick'];
207 $apcontact['about'] = HTML::toBBCode(JsonLD::fetchElement($compacted, 'as:summary', '@value'));
209 $apcontact['photo'] = JsonLD::fetchElement($compacted, 'as:icon', '@id');
210 if (is_array($apcontact['photo']) || !empty($compacted['as:icon']['as:url']['@id'])) {
211 $apcontact['photo'] = JsonLD::fetchElement($compacted['as:icon'], 'as:url', '@id');
214 $apcontact['header'] = JsonLD::fetchElement($compacted, 'as:image', '@id');
215 if (is_array($apcontact['header']) || !empty($compacted['as:image']['as:url']['@id'])) {
216 $apcontact['header'] = JsonLD::fetchElement($compacted['as:image'], 'as:url', '@id');
219 if (empty($apcontact['alias'])) {
220 $apcontact['alias'] = JsonLD::fetchElement($compacted, 'as:url', '@id');
221 if (is_array($apcontact['alias'])) {
222 $apcontact['alias'] = JsonLD::fetchElement($compacted['as:url'], 'as:href', '@id');
226 // Quit if none of the basic values are set
227 if (empty($apcontact['url']) || empty($apcontact['type']) || (($apcontact['type'] != 'Tombstone') && empty($apcontact['inbox']))) {
228 return $fetched_contact;
229 } elseif ($apcontact['type'] == 'Tombstone') {
230 // The "inbox" field must have a content
231 $apcontact['inbox'] = '';
234 // Quit if this doesn't seem to be an account at all
235 if (!in_array($apcontact['type'], ActivityPub::ACCOUNT_TYPES)) {
236 return $fetched_contact;
239 $parts = parse_url($apcontact['url']);
240 unset($parts['scheme']);
241 unset($parts['path']);
243 if (empty($apcontact['addr'])) {
244 if (!empty($apcontact['nick']) && is_array($parts)) {
245 $apcontact['addr'] = $apcontact['nick'] . '@' . str_replace('//', '', Network::unparseURL($parts));
247 $apcontact['addr'] = '';
251 $apcontact['pubkey'] = null;
252 if (!empty($compacted['w3id:publicKey'])) {
253 $apcontact['pubkey'] = trim(JsonLD::fetchElement($compacted['w3id:publicKey'], 'w3id:publicKeyPem', '@value'));
254 if (strstr($apcontact['pubkey'], 'RSA ')) {
255 $apcontact['pubkey'] = Crypto::rsaToPem($apcontact['pubkey']);
259 $apcontact['manually-approve'] = (int)JsonLD::fetchElement($compacted, 'as:manuallyApprovesFollowers');
261 if (!empty($compacted['as:generator'])) {
262 $apcontact['baseurl'] = JsonLD::fetchElement($compacted['as:generator'], 'as:url', '@id');
263 $apcontact['generator'] = JsonLD::fetchElement($compacted['as:generator'], 'as:name', '@value');
266 if (!empty($apcontact['following'])) {
267 $following = ActivityPub::fetchContent($apcontact['following']);
268 if (!empty($following['totalItems'])) {
269 $apcontact['following_count'] = $following['totalItems'];
273 if (!empty($apcontact['followers'])) {
274 $followers = ActivityPub::fetchContent($apcontact['followers']);
275 if (!empty($followers['totalItems'])) {
276 $apcontact['followers_count'] = $followers['totalItems'];
280 if (!empty($apcontact['outbox'])) {
281 $outbox = ActivityPub::fetchContent($apcontact['outbox']);
282 if (!empty($outbox['totalItems'])) {
283 $apcontact['statuses_count'] = $outbox['totalItems'];
290 // tag, attachment, image, nomadicLocations, signature, featured, movedTo, liked
292 // Unhandled from Misskey
293 // sharedInbox, isCat
295 // Unhandled from Kroeg
296 // kroeg:blocks, updated
298 // When the photo is too large, try to shorten it by removing parts
299 if (strlen($apcontact['photo']) > 255) {
300 $parts = parse_url($apcontact['photo']);
301 unset($parts['fragment']);
302 $apcontact['photo'] = Network::unparseURL($parts);
304 if (strlen($apcontact['photo']) > 255) {
305 unset($parts['query']);
306 $apcontact['photo'] = Network::unparseURL($parts);
309 if (strlen($apcontact['photo']) > 255) {
310 $apcontact['photo'] = substr($apcontact['photo'], 0, 255);
314 if (!$webfinger && !empty($apcontact['addr'])) {
315 $data = self::fetchWebfingerData($apcontact['addr']);
317 $apcontact['baseurl'] = $data['baseurl'];
319 if (empty($apcontact['alias']) && !empty($data['alias'])) {
320 $apcontact['alias'] = $data['alias'];
322 if (!empty($data['subscribe'])) {
323 $apcontact['subscribe'] = $data['subscribe'];
326 $apcontact['addr'] = null;
330 if (empty($apcontact['baseurl'])) {
331 $apcontact['baseurl'] = null;
334 if (empty($apcontact['subscribe'])) {
335 $apcontact['subscribe'] = null;
338 if (!empty($apcontact['baseurl']) && empty($fetched_contact['gsid'])) {
339 $apcontact['gsid'] = GServer::getID($apcontact['baseurl']);
340 } elseif (!empty($fetched_contact['gsid'])) {
341 $apcontact['gsid'] = $fetched_contact['gsid'];
343 $apcontact['gsid'] = null;
346 if ($apcontact['url'] == $apcontact['alias']) {
347 $apcontact['alias'] = null;
350 $apcontact['updated'] = DateTimeFormat::utcNow();
352 // We delete the old entry when the URL is changed
353 if ($url != $apcontact['url']) {
354 Logger::info('Delete changed profile url', ['old' => $url, 'new' => $apcontact['url']]);
355 DBA::delete('apcontact', ['url' => $url]);
358 // Limit the length on incoming fields
359 $apcontact = DBStructure::getFieldsForTable('apcontact', $apcontact);
361 if (DBA::exists('apcontact', ['url' => $apcontact['url']])) {
362 DBA::update('apcontact', $apcontact, ['url' => $apcontact['url']]);
364 DBA::replace('apcontact', $apcontact);
367 Logger::info('Updated profile', ['url' => $url]);
369 return DBA::selectFirst('apcontact', [], ['url' => $apcontact['url']]) ?: [];
373 * Mark the given AP Contact as "to archive"
375 * @param array $apcontact
378 public static function markForArchival(array $apcontact)
380 if (!empty($apcontact['inbox'])) {
381 Logger::info('Set inbox status to failure', ['inbox' => $apcontact['inbox']]);
382 HTTPSignature::setInboxStatus($apcontact['inbox'], false);
385 if (!empty($apcontact['sharedinbox'])) {
386 // Check if there are any available inboxes
387 $available = DBA::exists('apcontact', ["`sharedinbox` = ? AnD `inbox` IN (SELECT `url` FROM `inbox-status` WHERE `success` > `failure`)",
388 $apcontact['sharedinbox']]);
390 // If all known personal inboxes are failing then set their shared inbox to failure as well
391 Logger::info('Set shared inbox status to failure', ['sharedinbox' => $apcontact['sharedinbox']]);
392 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], false, true);
398 * Unmark the given AP Contact as "to archive"
400 * @param array $apcontact
403 public static function unmarkForArchival(array $apcontact)
405 if (!empty($apcontact['inbox'])) {
406 Logger::info('Set inbox status to success', ['inbox' => $apcontact['inbox']]);
407 HTTPSignature::setInboxStatus($apcontact['inbox'], true);
409 if (!empty($apcontact['sharedinbox'])) {
410 Logger::info('Set shared inbox status to success', ['sharedinbox' => $apcontact['sharedinbox']]);
411 HTTPSignature::setInboxStatus($apcontact['sharedinbox'], true, true);
418 * @param string $url inbox url
419 * @param boolean $shared Shared Inbox
421 private static function unarchiveInbox($url, $shared)
427 HTTPSignature::setInboxStatus($url, true, $shared);