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\Protocol\ActivityPub;
24 use Friendica\Content\Text\BBCode;
25 use Friendica\Database\DBA;
26 use Friendica\Content\Text\HTML;
27 use Friendica\Content\Text\Markdown;
28 use Friendica\Core\Logger;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\System;
31 use Friendica\Core\Worker;
33 use Friendica\Model\Contact;
34 use Friendica\Model\APContact;
35 use Friendica\Model\Item;
36 use Friendica\Model\Post;
37 use Friendica\Model\User;
38 use Friendica\Protocol\Activity;
39 use Friendica\Protocol\ActivityPub;
40 use Friendica\Util\DateTimeFormat;
41 use Friendica\Util\HTTPSignature;
42 use Friendica\Util\JsonLD;
43 use Friendica\Util\LDSignature;
44 use Friendica\Util\Network;
45 use Friendica\Util\Strings;
48 * ActivityPub Receiver Protocol class
53 * Check what this is meant to do:
62 const PUBLIC_COLLECTION = 'as:Public';
63 const ACCOUNT_TYPES = ['as:Person', 'as:Organization', 'as:Service', 'as:Group', 'as:Application'];
64 const CONTENT_TYPES = ['as:Note', 'as:Article', 'as:Video', 'as:Image', 'as:Event', 'as:Audio', 'as:Page', 'as:Question'];
65 const ACTIVITY_TYPES = ['as:Like', 'as:Dislike', 'as:Accept', 'as:Reject', 'as:TentativeAccept'];
67 const TARGET_UNKNOWN = 0;
72 const TARGET_FOLLOWER = 5;
73 const TARGET_ANSWER = 6;
74 const TARGET_GLOBAL = 7;
76 const COMPLETION_NONE = 0;
77 const COMPLETION_ANNOUCE = 1;
78 const COMPLETION_RELAY = 2;
79 const COMPLETION_MANUAL = 3;
80 const COMPLETION_AUTO = 4;
83 * Checks incoming message from the inbox
85 * @param string $body Body string
86 * @param array $header Header lines
87 * @param integer $uid User ID
91 public static function processInbox(string $body, array $header, int $uid)
93 $activity = json_decode($body, true);
94 if (empty($activity)) {
95 Logger::warning('Invalid body.');
99 $ldactivity = JsonLD::compact($activity);
101 $actor = JsonLD::fetchElement($ldactivity, 'as:actor', '@id') ?? '';
103 $apcontact = APContact::getByURL($actor);
105 if (empty($apcontact)) {
106 Logger::notice('Unable to retrieve AP contact for actor - message is discarded', ['actor' => $actor]);
108 } elseif (APContact::isRelay($apcontact)) {
109 self::processRelayPost($ldactivity, $actor);
112 APContact::unmarkForArchival($apcontact);
115 $http_signer = HTTPSignature::getSigner($body, $header);
116 if ($http_signer === false) {
117 Logger::warning('Invalid HTTP signature, message will be discarded.');
119 } elseif (empty($http_signer)) {
120 Logger::info('Signer is a tombstone. The message will be discarded, the signer account is deleted.');
123 Logger::info('Valid HTTP signature', ['signer' => $http_signer]);
126 $signer = [$http_signer];
128 Logger::info('Message for user ' . $uid . ' is from actor ' . $actor);
130 if (LDSignature::isSigned($activity)) {
131 $ld_signer = LDSignature::getSigner($activity);
132 if (empty($ld_signer)) {
133 Logger::info('Invalid JSON-LD signature from ' . $actor);
134 } elseif ($ld_signer != $http_signer) {
135 $signer[] = $ld_signer;
137 if (!empty($ld_signer && ($actor == $http_signer))) {
138 Logger::info('The HTTP and the JSON-LD signature belong to ' . $ld_signer);
139 $trust_source = true;
140 } elseif (!empty($ld_signer)) {
141 Logger::info('JSON-LD signature is signed by ' . $ld_signer);
142 $trust_source = true;
143 } elseif ($actor == $http_signer) {
144 Logger::info('Bad JSON-LD signature, but HTTP signer fits the actor.');
145 $trust_source = true;
147 Logger::info('Invalid JSON-LD signature and the HTTP signer is different.');
148 $trust_source = false;
150 } elseif ($actor == $http_signer) {
151 Logger::info('Trusting post without JSON-LD signature, The actor fits the HTTP signer.');
152 $trust_source = true;
154 Logger::info('No JSON-LD signature, different actor.');
155 $trust_source = false;
158 self::processActivity($ldactivity, $body, $uid, $trust_source, true, $signer, $http_signer);
162 * Process incoming posts from relays
164 * @param array $activity
165 * @param string $actor
168 private static function processRelayPost(array $activity, string $actor)
170 $type = JsonLD::fetchElement($activity, '@type');
172 Logger::info('Empty type', ['activity' => $activity, 'actor' => $actor]);
176 if ($type != 'as:Announce') {
177 Logger::info('Not an announcement', ['activity' => $activity, 'actor' => $actor]);
181 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
182 if (empty($object_id)) {
183 Logger::info('No object id found', ['activity' => $activity, 'actor' => $actor]);
187 $contact = Contact::getByURL($actor);
188 if (empty($contact)) {
189 Logger::info('Relay contact not found', ['actor' => $actor]);
193 if (!in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND])) {
194 Logger::notice('Relay is no sharer', ['actor' => $actor]);
198 Logger::info('Got relayed message id', ['id' => $object_id, 'actor' => $actor]);
200 $item_id = Item::searchByLink($object_id);
202 Logger::info('Relayed message already exists', ['id' => $object_id, 'item' => $item_id, 'actor' => $actor]);
206 $id = Processor::fetchMissingActivity($object_id, [], $actor, self::COMPLETION_RELAY);
208 Logger::notice('Relayed message had not been fetched', ['id' => $object_id, 'actor' => $actor]);
214 * Fetches the object type for a given object id
216 * @param array $activity
217 * @param string $object_id Object ID of the the provided object
218 * @param integer $uid User ID
220 * @return string with object type or NULL
221 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
222 * @throws \ImagickException
224 private static function fetchObjectType(array $activity, string $object_id, int $uid = 0)
226 if (!empty($activity['as:object'])) {
227 $object_type = JsonLD::fetchElement($activity['as:object'], '@type');
228 if (!empty($object_type)) {
233 if (Post::exists(['uri' => $object_id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]])) {
234 // We just assume "note" since it doesn't make a difference for the further processing
238 $profile = APContact::getByURL($object_id);
239 if (!empty($profile['type'])) {
240 APContact::unmarkForArchival($profile);
241 return 'as:' . $profile['type'];
244 $data = Processor::fetchCachedActivity($object_id, $uid);
246 $object = JsonLD::compact($data);
247 $type = JsonLD::fetchElement($object, '@type');
257 * Prepare the object array
259 * @param array $activity Array with activity data
260 * @param integer $uid User ID
261 * @param boolean $push Message had been pushed to our system
262 * @param boolean $trust_source Do we trust the source?
264 * @return array with object data
265 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
266 * @throws \ImagickException
268 public static function prepareObjectData(array $activity, int $uid, bool $push, bool &$trust_source): array
270 $id = JsonLD::fetchElement($activity, '@id');
271 $type = JsonLD::fetchElement($activity, '@type');
272 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
274 if (!empty($object_id) && in_array($type, ['as:Create', 'as:Update'])) {
275 $fetch_id = $object_id;
280 if (!empty($activity['as:object'])) {
281 $object_type = JsonLD::fetchElement($activity['as:object'], '@type');
284 if (!empty($id) && !$trust_source) {
285 $fetch_uid = $uid ?: self::getBestUserForActivity($activity);
287 $fetched_activity = Processor::fetchCachedActivity($fetch_id, $fetch_uid);
288 if (!empty($fetched_activity)) {
289 $object = JsonLD::compact($fetched_activity);
291 $fetched_id = JsonLD::fetchElement($object, '@id');
292 $fetched_type = JsonLD::fetchElement($object, '@type');
294 if (($fetched_id == $id) && !empty($fetched_type) && ($fetched_type == $type)) {
295 Logger::info('Activity had been fetched successfully', ['id' => $id]);
296 $trust_source = true;
298 } elseif (($fetched_id == $object_id) && !empty($fetched_type) && ($fetched_type == $object_type)) {
299 Logger::info('Fetched data is the object instead of the activity', ['id' => $id]);
300 $trust_source = true;
301 unset($object['@context']);
302 $activity['as:object'] = $object;
304 Logger::info('Activity id is not equal', ['id' => $id, 'fetched' => $fetched_id]);
307 Logger::info('Activity could not been fetched', ['id' => $id]);
311 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
313 Logger::info('Empty actor', ['activity' => $activity]);
317 $type = JsonLD::fetchElement($activity, '@type');
319 // Fetch all receivers from to, cc, bto and bcc
320 $receiverdata = self::getReceivers($activity, $actor);
321 $receivers = $reception_types = [];
322 foreach ($receiverdata as $key => $data) {
323 $receivers[$key] = $data['uid'];
324 $reception_types[$data['uid']] = $data['type'] ?? self::TARGET_UNKNOWN;
327 $urls = self::getReceiverURL($activity);
329 // When it is a delivery to a personal inbox we add that user to the receivers
331 $additional = [$uid => $uid];
332 $receivers = array_replace($receivers, $additional);
333 if (empty($activity['thread-completion']) && (empty($reception_types[$uid]) || in_array($reception_types[$uid], [self::TARGET_UNKNOWN, self::TARGET_FOLLOWER, self::TARGET_ANSWER, self::TARGET_GLOBAL]))) {
334 $reception_types[$uid] = self::TARGET_BCC;
335 $owner = User::getOwnerDataById($uid);
336 if (!empty($owner['url'])) {
337 $urls['as:bcc'][] = $owner['url'];
342 // We possibly need some user to fetch private content,
343 // so we fetch one out of the receivers if no uid is provided.
344 $fetch_uid = $uid ?: self::getBestUserForActivity($activity);
346 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
347 if (empty($object_id)) {
348 Logger::info('No object found');
352 if (!is_string($object_id)) {
353 Logger::info('Invalid object id', ['object' => $object_id]);
357 $object_type = self::fetchObjectType($activity, $object_id, $fetch_uid);
359 // Fetch the activity on Lemmy "Announce" messages (announces of activities)
360 if (($type == 'as:Announce') && in_array($object_type, array_merge(self::ACTIVITY_TYPES, ['as:Delete', 'as:Undo', 'as:Update']))) {
361 $data = Processor::fetchCachedActivity($object_id, $fetch_uid);
363 $type = $object_type;
364 $activity = JsonLD::compact($data);
366 // Some variables need to be refetched since the activity changed
367 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
368 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
369 $object_type = self::fetchObjectType($activity, $object_id, $fetch_uid);
373 // Any activities on account types must not be altered
374 if (in_array($object_type, self::ACCOUNT_TYPES)) {
376 $object_data['id'] = JsonLD::fetchElement($activity, '@id');
377 $object_data['object_id'] = JsonLD::fetchElement($activity, 'as:object', '@id');
378 $object_data['object_actor'] = JsonLD::fetchElement($activity['as:object'], 'as:actor', '@id');
379 $object_data['object_object'] = JsonLD::fetchElement($activity['as:object'], 'as:object');
380 $object_data['object_type'] = JsonLD::fetchElement($activity['as:object'], '@type');
381 $object_data['push'] = $push;
382 if (!$trust_source && ($type == 'as:Delete')) {
383 $apcontact = APContact::getByURL($object_data['object_id'], true);
384 $trust_source = empty($apcontact) || ($apcontact['type'] == 'Tombstone') || $apcontact['suspended'];
386 } elseif (in_array($type, ['as:Create', 'as:Update', 'as:Announce', 'as:Invite']) || strpos($type, '#emojiReaction')) {
387 // Fetch the content only on activities where this matters
388 // We can receive "#emojiReaction" when fetching content from Hubzilla systems
389 // Always fetch on "Announce"
390 $object_data = self::fetchObject($object_id, $activity['as:object'], $trust_source && ($type != 'as:Announce'), $fetch_uid);
391 if (empty($object_data)) {
392 Logger::info("Object data couldn't be processed");
396 $object_data['object_id'] = $object_id;
398 if ($type == 'as:Announce') {
399 $object_data['push'] = false;
401 $object_data['push'] = $push;
404 // Test if it is an answer to a mail
405 if (DBA::exists('mail', ['uri' => $object_data['reply-to-id']])) {
406 $object_data['directmessage'] = true;
408 $object_data['directmessage'] = JsonLD::fetchElement($activity, 'litepub:directMessage');
410 } elseif (in_array($type, array_merge(self::ACTIVITY_TYPES, ['as:Follow', 'litepub:EmojiReact', 'as:View'])) && in_array($object_type, self::CONTENT_TYPES)) {
411 // Create a mostly empty array out of the activity data (instead of the object).
412 // This way we later don't have to check for the existence of each individual array element.
413 $object_data = self::processObject($activity);
414 $object_data['name'] = $type;
415 $object_data['author'] = JsonLD::fetchElement($activity, 'as:actor', '@id');
416 $object_data['object_id'] = $object_id;
417 $object_data['object_type'] = ''; // Since we don't fetch the object, we don't know the type
418 $object_data['push'] = $push;
419 } elseif (in_array($type, ['as:Add', 'as:Remove'])) {
421 $object_data['id'] = JsonLD::fetchElement($activity, '@id');
422 $object_data['target_id'] = JsonLD::fetchElement($activity, 'as:target', '@id');
423 $object_data['object_id'] = JsonLD::fetchElement($activity, 'as:object', '@id');
424 $object_data['object_type'] = JsonLD::fetchElement($activity['as:object'], '@type');
425 $object_data['object_content'] = JsonLD::fetchElement($activity['as:object'], 'as:content', '@type');
426 $object_data['push'] = $push;
429 $object_data['id'] = JsonLD::fetchElement($activity, '@id');
430 $object_data['object_id'] = JsonLD::fetchElement($activity, 'as:object', '@id');
431 $object_data['object_actor'] = JsonLD::fetchElement($activity['as:object'], 'as:actor', '@id');
432 $object_data['object_object'] = JsonLD::fetchElement($activity['as:object'], 'as:object');
433 $object_data['object_type'] = JsonLD::fetchElement($activity['as:object'], '@type');
434 $object_data['push'] = $push;
436 // An Undo is done on the object of an object, so we need that type as well
437 if (($type == 'as:Undo') && !empty($object_data['object_object'])) {
438 $object_data['object_object_type'] = self::fetchObjectType([], $object_data['object_object'], $fetch_uid);
441 if (!$trust_source && ($type == 'as:Delete') && in_array($object_data['object_type'], array_merge(['as:Tombstone', ''], self::CONTENT_TYPES))) {
442 $trust_source = Processor::isActivityGone($object_data['object_id']);
443 if (!$trust_source) {
444 $trust_source = !empty(APContact::getByURL($object_data['object_id'], false));
449 $object_data = self::addActivityFields($object_data, $activity);
451 if (empty($object_data['object_type'])) {
452 $object_data['object_type'] = $object_type;
455 foreach (['as:to', 'as:cc', 'as:bto', 'as:bcc'] as $element) {
456 if ((empty($object_data['receiver_urls'][$element]) || in_array($element, ['as:bto', 'as:bcc'])) && !empty($urls[$element])) {
457 $object_data['receiver_urls'][$element] = array_unique(array_merge($object_data['receiver_urls'][$element] ?? [], $urls[$element]));
461 $object_data['type'] = $type;
462 $object_data['actor'] = $actor;
463 $object_data['item_receiver'] = $receivers;
464 $object_data['receiver'] = array_replace($object_data['receiver'] ?? [], $receivers);
465 $object_data['reception_type'] = array_replace($object_data['reception_type'] ?? [], $reception_types);
467 // This check here interferes with Hubzilla posts where the author host differs from the host the post was created
468 // $author = $object_data['author'] ?? $actor;
469 // if (!empty($author) && !empty($object_data['id'])) {
470 // $author_host = parse_url($author, PHP_URL_HOST);
471 // $id_host = parse_url($object_data['id'], PHP_URL_HOST);
472 // if ($author_host == $id_host) {
473 // Logger::info('Valid hosts', ['type' => $type, 'host' => $id_host]);
475 // Logger::notice('Differing hosts on author and id', ['type' => $type, 'author' => $author_host, 'id' => $id_host]);
476 // $trust_source = false;
480 Logger::info('Processing ' . $object_data['type'] . ' ' . $object_data['object_type'] . ' ' . $object_data['id']);
486 * Fetches the first user id from the receiver array
488 * @param array $receivers Array with receivers
489 * @return integer user id;
491 public static function getFirstUserFromReceivers(array $receivers): int
493 foreach ($receivers as $receiver) {
494 if (!empty($receiver)) {
502 * Processes the activity object
504 * @param array $activity Array with activity data
505 * @param string $body The unprocessed body
506 * @param int|null $uid User ID
507 * @param boolean $trust_source Do we trust the source?
508 * @param boolean $push Message had been pushed to our system
509 * @param array $signer The signer of the post
513 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
514 * @throws \ImagickException
516 public static function processActivity(array $activity, string $body = '', int $uid = null, bool $trust_source = false, bool $push = false, array $signer = [], string $http_signer = '', int $completion = Receiver::COMPLETION_AUTO): bool
518 $type = JsonLD::fetchElement($activity, '@type');
520 Logger::info('Empty type', ['activity' => $activity]);
524 if (!JsonLD::fetchElement($activity, 'as:object', '@id')) {
525 Logger::info('Empty object', ['activity' => $activity]);
529 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
531 Logger::info('Empty actor', ['activity' => $activity]);
535 if (is_array($activity['as:object'])) {
536 $attributed_to = JsonLD::fetchElement($activity['as:object'], 'as:attributedTo', '@id');
541 // Test the provided signatures against the actor and "attributedTo"
543 if (!empty($attributed_to) && !empty($actor)) {
544 $trust_source = (in_array($actor, $signer) && in_array($attributed_to, $signer));
546 $trust_source = in_array($actor, $signer);
550 // $trust_source is called by reference and is set to true if the content was retrieved successfully
551 $object_data = self::prepareObjectData($activity, $uid, $push, $trust_source);
552 if (empty($object_data)) {
553 Logger::info('No object data found', ['activity' => $activity]);
557 // Lemmy is announcing activities.
558 // We are changing the announces into regular activities.
559 if (($type == 'as:Announce') && in_array($object_data['type'] ?? '', array_merge(self::ACTIVITY_TYPES, ['as:Delete', 'as:Undo', 'as:Update']))) {
560 $type = $object_data['type'];
563 if (!empty($body) && empty($object_data['raw'])) {
564 $object_data['raw'] = $body;
567 // Internal flag for thread completion. See Processor.php
568 if (!empty($activity['thread-completion'])) {
569 $object_data['thread-completion'] = $activity['thread-completion'];
572 if (!empty($activity['completion-mode'])) {
573 $object_data['completion-mode'] = $activity['completion-mode'];
576 if (!empty($activity['thread-children-type'])) {
577 $object_data['thread-children-type'] = $activity['thread-children-type'];
580 // Internal flag for posts that arrived via relay
581 if (!empty($activity['from-relay'])) {
582 $object_data['from-relay'] = $activity['from-relay'];
585 if ($type == 'as:Announce') {
586 $object_data['object_activity'] = $activity;
589 if (($type == 'as:Create') && $trust_source) {
590 if (self::hasArrived($object_data['object_id'])) {
591 Logger::info('The activity already arrived.', ['id' => $object_data['object_id']]);
594 self::addArrivedId($object_data['object_id']);
596 if (Queue::exists($object_data['object_id'], $type)) {
597 Logger::info('The activity is already added.', ['id' => $object_data['object_id']]);
602 if (DI::config()->get('system', 'decoupled_receiver') && ($trust_source || DI::config()->get('debug', 'ap_inbox_store_untrusted'))) {
603 $object_data = Queue::add($object_data, $type, $uid, $http_signer, $push, $trust_source);
606 if (!$trust_source) {
607 Logger::info('Activity trust could not be achieved.', ['id' => $object_data['object_id'], 'type' => $type, 'signer' => $signer, 'actor' => $actor, 'attributedTo' => $attributed_to]);
611 if (!empty($object_data['entry-id']) && DI::config()->get('system', 'decoupled_receiver') && ($push || ($completion == self::COMPLETION_RELAY))) {
612 if (Queue::isProcessable($object_data['entry-id'])) {
613 // We delay by 5 seconds to allow to accumulate all receivers
614 $delayed = date(DateTimeFormat::MYSQL, time() + 5);
615 Logger::debug('Initiate processing', ['id' => $object_data['entry-id'], 'uri' => $object_data['object_id']]);
616 $wid = Worker::add(['priority' => PRIORITY_HIGH, 'delayed' => $delayed], 'ProcessQueue', $object_data['entry-id']);
617 Queue::setWorkerId($object_data['entry-id'], $wid);
619 Logger::debug('Other queue entries need to be processed first.', ['id' => $object_data['entry-id']]);
624 if (!empty($activity['recursion-depth'])) {
625 $object_data['recursion-depth'] = $activity['recursion-depth'];
628 if (in_array('as:Question', [$object_data['object_type'] ?? '', $object_data['object_object_type'] ?? ''])) {
629 self::storeUnhandledActivity(false, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
632 if (!self::routeActivities($object_data, $type, $push)) {
633 self::storeUnhandledActivity(true, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
634 Queue::remove($object_data);
642 * @param array $object_data
643 * @param string $type
645 * @param bool $fetch_parents
647 * @return boolean Could the activity be routed?
649 public static function routeActivities(array $object_data, string $type, bool $push, bool $fetch_parents = true): bool
651 $activity = $object_data['object_activity'] ?? [];
655 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
656 $item = ActivityPub\Processor::createItem($object_data, $fetch_parents);
657 ActivityPub\Processor::postItem($object_data, $item);
658 } elseif (in_array($object_data['object_type'], ['pt:CacheFile'])) {
659 // Unhandled Peertube activity
660 Queue::remove($object_data);
667 if (in_array($object_data['object_type'], ['as:Event'])) {
668 $item = ActivityPub\Processor::createItem($object_data, $fetch_parents);
669 ActivityPub\Processor::postItem($object_data, $item);
676 if ($object_data['object_type'] == 'as:tag') {
677 ActivityPub\Processor::addTag($object_data);
678 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
679 ActivityPub\Processor::addToFeaturedCollection($object_data);
680 } elseif ($object_data['object_type'] == '') {
681 // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
682 Queue::remove($object_data);
689 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
690 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
691 $object_data['thread-completion'] = Contact::getIdForURL($actor);
692 $object_data['completion-mode'] = self::COMPLETION_ANNOUCE;
694 if (!Post::exists(['uri' => $object_data['id'], 'uid' => 0])) {
695 $item = ActivityPub\Processor::createItem($object_data, $fetch_parents);
700 $item['post-reason'] = Item::PR_ANNOUNCEMENT;
701 ActivityPub\Processor::postItem($object_data, $item);
703 Logger::info('Announced id already exists', ['id' => $object_data['id']]);
704 Queue::remove($object_data);
707 if (!empty($activity)) {
708 $announce_object_data = self::processObject($activity);
709 $announce_object_data['name'] = $type;
710 $announce_object_data['author'] = $actor;
711 $announce_object_data['object_id'] = $object_data['object_id'];
712 $announce_object_data['object_type'] = $object_data['object_type'];
713 $announce_object_data['push'] = $push;
715 if (!empty($object_data['raw'])) {
716 $announce_object_data['raw'] = $object_data['raw'];
718 if (!empty($object_data['raw-object'])) {
719 $announce_object_data['raw-object'] = $object_data['raw-object'];
721 ActivityPub\Processor::createActivity($announce_object_data, Activity::ANNOUNCE);
729 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
730 ActivityPub\Processor::createActivity($object_data, Activity::LIKE);
731 } elseif ($object_data['object_type'] == '') {
732 // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
733 Queue::remove($object_data);
740 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
741 ActivityPub\Processor::createActivity($object_data, Activity::DISLIKE);
742 } elseif ($object_data['object_type'] == '') {
743 // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
744 Queue::remove($object_data);
750 case 'as:TentativeAccept':
751 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
752 ActivityPub\Processor::createActivity($object_data, Activity::ATTENDMAYBE);
759 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
760 ActivityPub\Processor::updateItem($object_data);
761 } elseif (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
762 ActivityPub\Processor::updatePerson($object_data);
763 } elseif (in_array($object_data['object_type'], ['pt:CacheFile'])) {
764 // Unhandled Peertube activity
765 Queue::remove($object_data);
772 if (in_array($object_data['object_type'], array_merge(['as:Tombstone'], self::CONTENT_TYPES))) {
773 ActivityPub\Processor::deleteItem($object_data);
774 } elseif (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
775 ActivityPub\Processor::deletePerson($object_data);
776 } elseif ($object_data['object_type'] == '') {
777 // The object type couldn't be determined. Most likely we don't have it here. We ignore this activity.
778 Queue::remove($object_data);
785 if (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
786 ActivityPub\Processor::blockAccount($object_data);
793 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
794 ActivityPub\Processor::removeFromFeaturedCollection($object_data);
795 } elseif ($object_data['object_type'] == '') {
796 // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
797 Queue::remove($object_data);
804 if (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
805 ActivityPub\Processor::followUser($object_data);
806 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
807 $object_data['reply-to-id'] = $object_data['object_id'];
808 ActivityPub\Processor::createActivity($object_data, Activity::FOLLOW);
815 if ($object_data['object_type'] == 'as:Follow') {
816 ActivityPub\Processor::acceptFollowUser($object_data);
817 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
818 ActivityPub\Processor::createActivity($object_data, Activity::ATTEND);
825 if ($object_data['object_type'] == 'as:Follow') {
826 ActivityPub\Processor::rejectFollowUser($object_data);
827 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
828 ActivityPub\Processor::createActivity($object_data, Activity::ATTENDNO);
835 if (($object_data['object_type'] == 'as:Follow') &&
836 in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
837 ActivityPub\Processor::undoFollowUser($object_data);
838 } elseif (($object_data['object_type'] == 'as:Follow') &&
839 in_array($object_data['object_object_type'], self::CONTENT_TYPES)) {
840 ActivityPub\Processor::undoActivity($object_data);
841 } elseif (($object_data['object_type'] == 'as:Accept') &&
842 in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
843 ActivityPub\Processor::rejectFollowUser($object_data);
844 } elseif (($object_data['object_type'] == 'as:Block') &&
845 in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
846 ActivityPub\Processor::unblockAccount($object_data);
847 } elseif (in_array($object_data['object_type'], array_merge(self::ACTIVITY_TYPES, ['as:Announce'])) &&
848 in_array($object_data['object_object_type'], array_merge(['as:Tombstone'], self::CONTENT_TYPES))) {
849 ActivityPub\Processor::undoActivity($object_data);
850 } elseif (in_array($object_data['object_type'], array_merge(self::ACTIVITY_TYPES, ['as:Announce', 'as:Create', ''])) &&
851 empty($object_data['object_object_type'])) {
852 // We cannot detect the target object. So we can ignore it.
853 Queue::remove($object_data);
854 } elseif (in_array($object_data['object_type'], ['as:Create']) &&
855 in_array($object_data['object_object_type'], ['pt:CacheFile'])) {
856 // Unhandled Peertube activity
857 Queue::remove($object_data);
864 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
865 ActivityPub\Processor::createActivity($object_data, Activity::VIEW);
866 } elseif ($object_data['object_type'] == '') {
867 // The object type couldn't be determined. Most likely we don't have it here. We ignore this activity.
868 Queue::remove($object_data);
874 case 'litepub:EmojiReact':
875 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
876 ActivityPub\Processor::createActivity($object_data, Activity::EMOJIREACT);
877 } elseif ($object_data['object_type'] == '') {
878 // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
879 Queue::remove($object_data);
886 Logger::info('Unknown activity: ' . $type . ' ' . $object_data['object_type']);
893 * Stores unhandled or unknown Activities as a file
895 * @param boolean $unknown "true" if the activity is unknown, "false" if it is unhandled
896 * @param string $type Activity type
897 * @param array $object_data Preprocessed array that is generated out of the received activity
898 * @param array $activity Array with activity data
899 * @param string $body The unprocessed body
900 * @param integer $uid User ID
901 * @param boolean $trust_source Do we trust the source?
902 * @param boolean $push Message had been pushed to our system
903 * @param array $signer The signer of the post
906 private static function storeUnhandledActivity(bool $unknown, string $type, array $object_data, array $activity, string $body = '', int $uid = null, bool $trust_source = false, bool $push = false, array $signer = [])
908 if (!DI::config()->get('debug', 'ap_log_unknown')) {
912 $file = ($unknown ? 'unknown-' : 'unhandled-') . str_replace(':', '-', $type) . '-';
914 if (!empty($object_data['object_type'])) {
915 $file .= str_replace(':', '-', $object_data['object_type']) . '-';
918 if (!empty($object_data['object_object_type'])) {
919 $file .= str_replace(':', '-', $object_data['object_object_type']) . '-';
922 $tempfile = tempnam(System::getTempPath(), $file);
923 file_put_contents($tempfile, json_encode(['activity' => $activity, 'body' => $body, 'uid' => $uid, 'trust_source' => $trust_source, 'push' => $push, 'signer' => $signer, 'object_data' => $object_data], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
924 Logger::notice('Unknown activity stored', ['type' => $type, 'object_type' => $object_data['object_type'], $object_data['object_object_type'] ?? '', 'file' => $tempfile]);
928 * Fetch a user id from an activity array
930 * @param array $activity
931 * @param string $actor
933 * @return int user id
935 public static function getBestUserForActivity(array $activity): int
938 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id') ?? '';
940 $receivers = self::getReceivers($activity, $actor);
941 foreach ($receivers as $receiver) {
942 if ($receiver['type'] == self::TARGET_GLOBAL) {
945 if (empty($uid) || ($receiver['type'] == self::TARGET_TO)) {
946 $uid = $receiver['uid'];
950 // When we haven't found any user yet, we just chose a user who most likely could have access to the content
952 $contact = Contact::selectFirst(['uid'], ['nurl' => Strings::normaliseLink($actor), 'rel' => [Contact::SHARING, Contact::FRIEND]]);
953 if (!empty($contact['uid'])) {
954 $uid = $contact['uid'];
961 // @TODO Missing documentation
962 public static function getReceiverURL(array $activity): array
966 foreach (['as:to', 'as:cc', 'as:bto', 'as:bcc'] as $element) {
967 $receiver_list = JsonLD::fetchElementArray($activity, $element, '@id');
968 if (empty($receiver_list)) {
972 foreach ($receiver_list as $receiver) {
973 if ($receiver == self::PUBLIC_COLLECTION) {
974 $receiver = ActivityPub::PUBLIC_COLLECTION;
976 $urls[$element][] = $receiver;
984 * Fetch the receiver list from an activity array
986 * @param array $activity
987 * @param string $actor
989 * @param boolean $fetch_unlisted
991 * @return array with receivers (user id)
994 private static function getReceivers(array $activity, string $actor, array $tags = [], bool $fetch_unlisted = false): array
996 $reply = $receivers = $profile = [];
998 // When it is an answer, we inherite the receivers from the parent
999 $replyto = JsonLD::fetchElement($activity, 'as:inReplyTo', '@id');
1000 if (!empty($replyto)) {
1001 $reply = [$replyto];
1003 // Fix possibly wrong item URI (could be an answer to a plink uri)
1004 $fixedReplyTo = Item::getURIByLink($replyto);
1005 if (!empty($fixedReplyTo)) {
1006 $reply[] = $fixedReplyTo;
1010 // Fetch all posts that refer to the object id
1011 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
1012 if (!empty($object_id)) {
1013 $reply[] = $object_id;
1016 if (!empty($reply)) {
1017 $parents = Post::select(['uid'], DBA::mergeConditions(['uri' => $reply], ["`uid` != ?", 0]));
1018 while ($parent = Post::fetch($parents)) {
1019 $receivers[$parent['uid']] = ['uid' => $parent['uid'], 'type' => self::TARGET_ANSWER];
1021 DBA::close($parents);
1024 if (!empty($actor)) {
1025 $profile = APContact::getByURL($actor);
1026 $followers = $profile['followers'] ?? '';
1027 $is_forum = ($actor['type'] ?? '') == 'Group';
1028 Logger::info('Got actor and followers', ['actor' => $actor, 'followers' => $followers]);
1030 Logger::info('Empty actor', ['activity' => $activity]);
1035 // We have to prevent false follower assumptions upon thread completions
1036 $follower_target = empty($activity['thread-completion']) ? self::TARGET_FOLLOWER : self::TARGET_UNKNOWN;
1038 foreach (['as:to', 'as:cc', 'as:bto', 'as:bcc'] as $element) {
1039 $receiver_list = JsonLD::fetchElementArray($activity, $element, '@id');
1040 if (empty($receiver_list)) {
1044 foreach ($receiver_list as $receiver) {
1045 if ($receiver == self::PUBLIC_COLLECTION) {
1046 $receivers[0] = ['uid' => 0, 'type' => self::TARGET_GLOBAL];
1049 // Add receiver "-1" for unlisted posts
1050 if ($fetch_unlisted && ($receiver == self::PUBLIC_COLLECTION) && ($element == 'as:cc')) {
1051 $receivers[-1] = ['uid' => -1, 'type' => self::TARGET_GLOBAL];
1054 // Fetch the receivers for the public and the followers collection
1055 if ((($receiver == $followers) || (($receiver == self::PUBLIC_COLLECTION) && !$is_forum)) && !empty($actor)) {
1056 $receivers = self::getReceiverForActor($actor, $tags, $receivers, $follower_target, $profile);
1060 // Fetching all directly addressed receivers
1061 $condition = ['self' => true, 'nurl' => Strings::normaliseLink($receiver)];
1062 $contact = DBA::selectFirst('contact', ['uid', 'contact-type'], $condition);
1063 if (!DBA::isResult($contact)) {
1067 // Check if the potential receiver is following the actor
1068 // Exception: The receiver is targetted via "to" or this is a comment
1069 if ((($element != 'as:to') && empty($replyto)) || ($contact['contact-type'] == Contact::TYPE_COMMUNITY)) {
1070 $networks = Protocol::FEDERATED;
1071 $condition = ['nurl' => Strings::normaliseLink($actor), 'rel' => [Contact::SHARING, Contact::FRIEND],
1072 'network' => $networks, 'archive' => false, 'pending' => false, 'uid' => $contact['uid']];
1074 // Forum posts are only accepted from forum contacts
1075 if ($contact['contact-type'] == Contact::TYPE_COMMUNITY) {
1076 $condition['rel'] = [Contact::SHARING, Contact::FRIEND, Contact::FOLLOWER];
1079 if (!DBA::exists('contact', $condition)) {
1084 $type = $receivers[$contact['uid']]['type'] ?? self::TARGET_UNKNOWN;
1085 if (in_array($type, [self::TARGET_UNKNOWN, self::TARGET_FOLLOWER, self::TARGET_ANSWER, self::TARGET_GLOBAL])) {
1088 $type = self::TARGET_TO;
1091 $type = self::TARGET_CC;
1094 $type = self::TARGET_BTO;
1097 $type = self::TARGET_BCC;
1101 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $type];
1106 self::switchContacts($receivers, $actor);
1112 * Fetch the receiver list of a given actor
1114 * @param string $actor
1115 * @param array $tags
1116 * @param array $receivers
1117 * @param integer $target_type
1118 * @param array $profile
1120 * @return array with receivers (user id)
1121 * @throws \Exception
1123 private static function getReceiverForActor(string $actor, array $tags, array $receivers, int $target_type, array $profile): array
1125 $basecondition = ['rel' => [Contact::SHARING, Contact::FRIEND, Contact::FOLLOWER],
1126 'network' => Protocol::FEDERATED, 'archive' => false, 'pending' => false];
1128 if (!empty($profile['uri-id'])) {
1129 $condition = DBA::mergeConditions($basecondition, ["`uri-id` = ? AND `uid` != ?", $profile['uri-id'], 0]);
1130 $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
1131 while ($contact = DBA::fetch($contacts)) {
1132 if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
1133 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
1136 DBA::close($contacts);
1138 // This part will only be called while post update 1426 wasn't finished
1139 $condition = DBA::mergeConditions($basecondition, ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($actor), 0]);
1140 $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
1141 while ($contact = DBA::fetch($contacts)) {
1142 if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
1143 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
1146 DBA::close($contacts);
1148 // The queries are split because of performance issues
1149 $condition = DBA::mergeConditions($basecondition, ["`alias` IN (?, ?) AND `uid` != ?", Strings::normaliseLink($actor), $actor, 0]);
1150 $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
1151 while ($contact = DBA::fetch($contacts)) {
1152 if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
1153 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
1156 DBA::close($contacts);
1162 * Tests if the contact is a valid receiver for this actor
1164 * @param array $contact
1165 * @param array $tags
1167 * @return bool with receivers (user id)
1168 * @throws \Exception
1170 private static function isValidReceiverForActor(array $contact, array $tags): bool
1172 // Are we following the contact? Then this is a valid receiver
1173 if (in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND])) {
1177 // When the possible receiver isn't a community, then it is no valid receiver
1178 $owner = User::getOwnerDataById($contact['uid']);
1179 if (empty($owner) || ($owner['contact-type'] != Contact::TYPE_COMMUNITY)) {
1183 // Is the community account tagged?
1184 foreach ($tags as $tag) {
1185 if ($tag['type'] != 'Mention') {
1189 if (Strings::compareLink($tag['href'], $owner['url'])) {
1198 * Switches existing contacts to ActivityPub
1200 * @param integer $cid Contact ID
1201 * @param integer $uid User ID
1202 * @param string $url Profile URL
1204 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1205 * @throws \ImagickException
1207 public static function switchContact(int $cid, int $uid, string $url)
1209 if (DBA::exists('contact', ['id' => $cid, 'network' => Protocol::ACTIVITYPUB])) {
1210 Logger::info('Contact is already ActivityPub', ['id' => $cid, 'uid' => $uid, 'url' => $url]);
1214 if (Contact::updateFromProbe($cid)) {
1215 Logger::info('Update was successful', ['id' => $cid, 'uid' => $uid, 'url' => $url]);
1218 // Send a new follow request to be sure that the connection still exists
1219 if (($uid != 0) && DBA::exists('contact', ['id' => $cid, 'rel' => [Contact::SHARING, Contact::FRIEND], 'network' => Protocol::ACTIVITYPUB])) {
1220 Logger::info('Contact had been switched to ActivityPub. Sending a new follow request.', ['uid' => $uid, 'url' => $url]);
1221 ActivityPub\Transmitter::sendActivity('Follow', $url, $uid);
1226 * @TODO Fix documentation and type-hints
1231 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1232 * @throws \ImagickException
1234 private static function switchContacts($receivers, $actor)
1236 if (empty($actor)) {
1240 foreach ($receivers as $receiver) {
1241 $contact = DBA::selectFirst('contact', ['id'], ['uid' => $receiver['uid'], 'network' => Protocol::OSTATUS, 'nurl' => Strings::normaliseLink($actor)]);
1242 if (DBA::isResult($contact)) {
1243 self::switchContact($contact['id'], $receiver['uid'], $actor);
1246 $contact = DBA::selectFirst('contact', ['id'], ['uid' => $receiver['uid'], 'network' => Protocol::OSTATUS, 'alias' => [Strings::normaliseLink($actor), $actor]]);
1247 if (DBA::isResult($contact)) {
1248 self::switchContact($contact['id'], $receiver['uid'], $actor);
1254 * @TODO Fix documentation and type-hints
1256 * @param $object_data
1257 * @param array $activity
1261 private static function addActivityFields($object_data, array $activity)
1263 if (!empty($activity['published']) && empty($object_data['published'])) {
1264 $object_data['published'] = JsonLD::fetchElement($activity, 'as:published', '@value');
1267 if (!empty($activity['diaspora:guid']) && empty($object_data['diaspora:guid'])) {
1268 $object_data['diaspora:guid'] = JsonLD::fetchElement($activity, 'diaspora:guid', '@value');
1271 $object_data['service'] = JsonLD::fetchElement($activity, 'as:instrument', 'as:name', '@type', 'as:Service');
1272 $object_data['service'] = JsonLD::fetchElement($object_data, 'service', '@value');
1274 if (!empty($object_data['object_id'])) {
1275 // Some systems (e.g. GNU Social) don't reply to the "id" field but the "uri" field.
1276 $objectId = Item::getURIByLink($object_data['object_id']);
1277 if (!empty($objectId) && ($object_data['object_id'] != $objectId)) {
1278 Logger::notice('Fix wrong object-id', ['received' => $object_data['object_id'], 'correct' => $objectId]);
1279 $object_data['object_id'] = $objectId;
1283 return $object_data;
1287 * Fetches the object data from external ressources if needed
1289 * @param string $object_id Object ID of the the provided object
1290 * @param array $object The provided object array
1291 * @param boolean $trust_source Do we trust the provided object?
1292 * @param integer $uid User ID for the signature that we use to fetch data
1294 * @return array|false with trusted and valid object data
1295 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1296 * @throws \ImagickException
1298 private static function fetchObject(string $object_id, array $object = [], bool $trust_source = false, int $uid = 0)
1300 // By fetching the type we check if the object is complete.
1301 $type = JsonLD::fetchElement($object, '@type');
1303 if (!$trust_source || empty($type)) {
1304 $data = Processor::fetchCachedActivity($object_id, $uid);
1305 if (!empty($data)) {
1306 $object = JsonLD::compact($data);
1307 Logger::info('Fetched content for ' . $object_id);
1309 Logger::info('Empty content for ' . $object_id . ', check if content is available locally.');
1311 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, ['uri' => $object_id]);
1312 if (!DBA::isResult($item)) {
1313 Logger::info('Object with url ' . $object_id . ' was not found locally.');
1316 Logger::info('Using already stored item for url ' . $object_id);
1317 $data = ActivityPub\Transmitter::createNote($item);
1318 $object = JsonLD::compact($data);
1321 $id = JsonLD::fetchElement($object, '@id');
1323 Logger::info('Empty id');
1327 if ($id != $object_id) {
1328 Logger::info('Fetched id differs from provided id', ['provided' => $object_id, 'fetched' => $id]);
1332 Logger::info('Using original object for url ' . $object_id);
1335 $type = JsonLD::fetchElement($object, '@type');
1337 Logger::info('Empty type');
1341 // Lemmy is resharing "create" activities instead of content
1342 // We fetch the content from the activity.
1343 if (in_array($type, ['as:Create'])) {
1344 $object = $object['as:object'];
1345 $type = JsonLD::fetchElement($object, '@type');
1347 Logger::info('Empty type');
1350 $object_data = self::processObject($object);
1353 // We currently don't handle 'pt:CacheFile', but with this step we avoid logging
1354 if (in_array($type, self::CONTENT_TYPES) || ($type == 'pt:CacheFile')) {
1355 $object_data = self::processObject($object);
1357 if (!empty($data)) {
1358 $object_data['raw-object'] = json_encode($data);
1360 return $object_data;
1363 if ($type == 'as:Announce') {
1364 $object_id = JsonLD::fetchElement($object, 'object', '@id');
1365 if (empty($object_id) || !is_string($object_id)) {
1368 return self::fetchObject($object_id, [], false, $uid);
1371 Logger::info('Unhandled object type: ' . $type);
1376 * Converts the language element (Used by Peertube)
1378 * @param array $languages
1379 * @return array Languages
1381 public static function processLanguages(array $languages): array
1383 if (empty($languages)) {
1387 $language_list = [];
1389 foreach ($languages as $language) {
1390 if (!empty($language['_:identifier']) && !empty($language['as:name'])) {
1391 $language_list[$language['_:identifier']] = $language['as:name'];
1394 return $language_list;
1398 * Convert tags from JSON-LD format into a simplified format
1400 * @param array $tags Tags in JSON-LD format
1402 * @return array with tags in a simplified format
1404 public static function processTags(array $tags): array
1408 foreach ($tags as $tag) {
1413 $element = ['type' => str_replace('as:', '', JsonLD::fetchElement($tag, '@type')),
1414 'href' => JsonLD::fetchElement($tag, 'as:href', '@id'),
1415 'name' => JsonLD::fetchElement($tag, 'as:name', '@value')];
1417 if (empty($element['type'])) {
1421 if (empty($element['href'])) {
1422 $element['href'] = $element['name'];
1425 $taglist[] = $element;
1431 * Convert emojis from JSON-LD format into a simplified format
1433 * @param array $emojis
1434 * @return array with emojis in a simplified format
1436 private static function processEmojis(array $emojis): array
1440 foreach ($emojis as $emoji) {
1441 if (empty($emoji) || (JsonLD::fetchElement($emoji, '@type') != 'toot:Emoji') || empty($emoji['as:icon'])) {
1445 $url = JsonLD::fetchElement($emoji['as:icon'], 'as:url', '@id');
1446 $element = ['name' => JsonLD::fetchElement($emoji, 'as:name', '@value'),
1449 $emojilist[] = $element;
1456 * Convert attachments from JSON-LD format into a simplified format
1458 * @param array $attachments Attachments in JSON-LD format
1460 * @return array Attachments in a simplified format
1462 private static function processAttachments(array $attachments): array
1466 // Removes empty values
1467 $attachments = array_filter($attachments);
1469 foreach ($attachments as $attachment) {
1470 switch (JsonLD::fetchElement($attachment, '@type')) {
1475 $urls = JsonLD::fetchElementArray($attachment, 'as:url');
1476 foreach ($urls as $url) {
1477 // Single scalar URL case
1478 if (is_string($url)) {
1483 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1484 $mediaType = JsonLD::fetchElement($url, 'as:mediaType', '@value');
1485 if (Strings::startsWith($mediaType, 'image')) {
1494 'title' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
1495 'desc' => JsonLD::fetchElement($attachment, 'as:summary', '@value'),
1497 'image' => $pageImage,
1501 $mediaType = JsonLD::fetchElement($attachment, 'as:mediaType', '@value');
1502 $imageFullUrl = JsonLD::fetchElement($attachment, 'as:url', '@id');
1503 $imagePreviewUrl = null;
1505 if (!$imageFullUrl && ($urls = JsonLD::fetchElementArray($attachment, 'as:url'))) {
1506 $imageVariants = [];
1507 $previewVariants = [];
1508 foreach ($urls as $url) {
1509 // Scalar URL, no discrimination possible
1510 if (is_string($url)) {
1511 $imageFullUrl = $url;
1515 // Not sure what to do with a different Link media type than the base Image, we skip
1516 if ($mediaType != JsonLD::fetchElement($url, 'as:mediaType', '@value')) {
1520 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1522 // Default URL choice if no discriminating width is provided
1523 $imageFullUrl = $href ?? $imageFullUrl;
1525 $width = intval(JsonLD::fetchElement($url, 'as:width', '@value') ?? 1);
1527 if ($href && $width) {
1528 $imageVariants[$width] = $href;
1529 // 632 is the ideal width for full screen frio posts, we compute the absolute distance to it
1530 $previewVariants[abs(632 - $width)] = $href;
1534 if ($imageVariants) {
1535 // Taking the maximum size image
1536 ksort($imageVariants);
1537 $imageFullUrl = array_pop($imageVariants);
1539 // Taking the minimum number distance to the target distance
1540 ksort($previewVariants);
1541 $imagePreviewUrl = array_shift($previewVariants);
1544 unset($imageVariants);
1545 unset($previewVariants);
1549 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
1550 'mediaType' => $mediaType,
1551 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
1552 'url' => $imageFullUrl,
1553 'image' => $imagePreviewUrl !== $imageFullUrl ? $imagePreviewUrl : null,
1558 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
1559 'mediaType' => JsonLD::fetchElement($attachment, 'as:mediaType', '@value'),
1560 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
1561 'url' => JsonLD::fetchElement($attachment, 'as:url', '@id'),
1562 'height' => JsonLD::fetchElement($attachment, 'as:height', '@value'),
1563 'width' => JsonLD::fetchElement($attachment, 'as:width', '@value'),
1564 'image' => JsonLD::fetchElement($attachment, 'as:image', '@id')
1573 * Convert questions from JSON-LD format into a simplified format
1575 * @param array $object
1577 * @return array Questions in a simplified format
1579 private static function processQuestion(array $object): array
1583 if (!empty($object['as:oneOf'])) {
1584 $question['multiple'] = false;
1585 $options = JsonLD::fetchElementArray($object, 'as:oneOf') ?? [];
1586 } elseif (!empty($object['as:anyOf'])) {
1587 $question['multiple'] = true;
1588 $options = JsonLD::fetchElementArray($object, 'as:anyOf') ?? [];
1593 $closed = JsonLD::fetchElement($object, 'as:closed', '@value');
1594 if (!empty($closed)) {
1595 $question['end-time'] = $closed;
1597 $question['end-time'] = JsonLD::fetchElement($object, 'as:endTime', '@value');
1600 $question['voters'] = (int)JsonLD::fetchElement($object, 'toot:votersCount', '@value');
1601 $question['options'] = [];
1605 foreach ($options as $option) {
1606 if (JsonLD::fetchElement($option, '@type') != 'as:Note') {
1610 $name = JsonLD::fetchElement($option, 'as:name', '@value');
1612 if (empty($option['as:replies'])) {
1616 $replies = JsonLD::fetchElement($option['as:replies'], 'as:totalItems', '@value');
1618 $question['options'][] = ['name' => $name, 'replies' => $replies];
1620 $voters += (int)$replies;
1623 // For single choice question we can count the number of voters if not provided (like with Misskey)
1624 if (empty($question['voters']) && !$question['multiple']) {
1625 $question['voters'] = $voters;
1632 * Fetch the original source or content with the "language" Markdown or HTML
1634 * @param array $object
1635 * @param array $object_data
1637 * @return array Object data (?)
1638 * @throws \Exception
1640 private static function getSource(array $object, array $object_data): array
1642 $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/bbcode');
1643 $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
1644 if (!empty($object_data['source'])) {
1645 return $object_data;
1648 $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/markdown');
1649 $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
1650 if (!empty($object_data['source'])) {
1651 $object_data['source'] = Markdown::toBBCode($object_data['source']);
1652 return $object_data;
1655 $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/html');
1656 $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
1657 if (!empty($object_data['source'])) {
1658 $object_data['source'] = HTML::toBBCode($object_data['source']);
1659 return $object_data;
1662 return $object_data;
1666 * Extracts a potential alternate URL from a list of additional URL elements
1668 * @param array $urls
1671 private static function extractAlternateUrl(array $urls): string
1674 foreach ($urls as $key => $url) {
1675 // Not a list but a single URL element
1676 if (!is_numeric($key)) {
1680 if (empty($url['@type']) || ($url['@type'] != 'as:Link')) {
1684 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1689 $mediatype = JsonLD::fetchElement($url, 'as:mediaType');
1690 if (empty($mediatype)) {
1694 if ($mediatype == 'text/html') {
1695 $alternateUrl = $href;
1699 return $alternateUrl;
1703 * Check if the "as:url" element is an array with multiple links
1704 * This is the case with audio and video posts.
1705 * Then the links are added as attachments
1707 * @param array $urls The object URL list
1708 * @return array an array of attachments
1710 private static function processAttachmentUrls(array $urls): array
1713 foreach ($urls as $key => $url) {
1714 // Not a list but a single URL element
1715 if (!is_numeric($key)) {
1719 if (empty($url['@type']) || ($url['@type'] != 'as:Link')) {
1723 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1728 $mediatype = JsonLD::fetchElement($url, 'as:mediaType');
1729 if (empty($mediatype)) {
1733 $filetype = strtolower(substr($mediatype, 0, strpos($mediatype, '/')));
1735 if ($filetype == 'audio') {
1736 $attachments[] = ['type' => $filetype, 'mediaType' => $mediatype, 'url' => $href, 'height' => null, 'size' => null, 'name' => ''];
1737 } elseif ($filetype == 'video') {
1738 $height = (int)JsonLD::fetchElement($url, 'as:height', '@value');
1739 // PeerTube audio-only track
1740 if ($height === 0) {
1744 $size = (int)JsonLD::fetchElement($url, 'pt:size', '@value');
1745 $attachments[] = ['type' => $filetype, 'mediaType' => $mediatype, 'url' => $href, 'height' => $height, 'size' => $size, 'name' => ''];
1746 } elseif (in_array($mediatype, ['application/x-bittorrent', 'application/x-bittorrent;x-scheme-handler/magnet'])) {
1747 $height = (int)JsonLD::fetchElement($url, 'as:height', '@value');
1749 // For Torrent links we always store the highest resolution
1750 if (!empty($attachments[$mediatype]['height']) && ($height < $attachments[$mediatype]['height'])) {
1754 $attachments[$mediatype] = ['type' => $mediatype, 'mediaType' => $mediatype, 'url' => $href, 'height' => $height, 'size' => null, 'name' => ''];
1755 } elseif ($mediatype == 'application/x-mpegURL') {
1756 // PeerTube exception, actual video link is in the tags of this URL element
1757 $attachments = array_merge($attachments, self::processAttachmentUrls($url['as:tag']));
1761 return array_values($attachments);
1765 * Fetches data from the object part of an activity
1767 * @param array $object
1769 * @return array|bool Object data or FALSE if $object does not contain @id element
1770 * @throws \Exception
1772 private static function processObject(array $object)
1774 if (!JsonLD::fetchElement($object, '@id')) {
1779 $object_data['object_type'] = JsonLD::fetchElement($object, '@type');
1780 $object_data['id'] = JsonLD::fetchElement($object, '@id');
1781 $object_data['reply-to-id'] = JsonLD::fetchElement($object, 'as:inReplyTo', '@id');
1783 // An empty "id" field is translated to "./" by the compactor, so we have to check for this content
1784 if (empty($object_data['reply-to-id']) || ($object_data['reply-to-id'] == './')) {
1785 $object_data['reply-to-id'] = $object_data['id'];
1787 // On activities the "reply to" is the id of the object it refers to
1788 if (in_array($object_data['object_type'], self::ACTIVITY_TYPES)) {
1789 $object_id = JsonLD::fetchElement($object, 'as:object', '@id');
1790 if (!empty($object_id)) {
1791 $object_data['reply-to-id'] = $object_id;
1795 // Some systems (e.g. GNU Social) don't reply to the "id" field but the "uri" field.
1796 $replyToId = Item::getURIByLink($object_data['reply-to-id']);
1797 if (!empty($replyToId) && ($object_data['reply-to-id'] != $replyToId)) {
1798 Logger::notice('Fix wrong reply-to', ['received' => $object_data['reply-to-id'], 'correct' => $replyToId]);
1799 $object_data['reply-to-id'] = $replyToId;
1803 $object_data['published'] = JsonLD::fetchElement($object, 'as:published', '@value');
1804 $object_data['updated'] = JsonLD::fetchElement($object, 'as:updated', '@value');
1806 if (empty($object_data['updated'])) {
1807 $object_data['updated'] = $object_data['published'];
1810 if (empty($object_data['published']) && !empty($object_data['updated'])) {
1811 $object_data['published'] = $object_data['updated'];
1814 $actor = JsonLD::fetchElement($object, 'as:attributedTo', '@id');
1815 if (empty($actor)) {
1816 $actor = JsonLD::fetchElement($object, 'as:actor', '@id');
1819 $location = JsonLD::fetchElement($object, 'as:location', 'as:name', '@type', 'as:Place');
1820 $location = JsonLD::fetchElement($location, 'location', '@value');
1822 // Some AP software allow formatted text in post location, so we run all the text converters we have to boil
1823 // down to HTML and then finally format to plaintext.
1824 $location = Markdown::convert($location);
1825 $location = BBCode::toPlaintext($location);
1828 $object_data['sc:identifier'] = JsonLD::fetchElement($object, 'sc:identifier', '@value');
1829 $object_data['diaspora:guid'] = JsonLD::fetchElement($object, 'diaspora:guid', '@value');
1830 $object_data['diaspora:comment'] = JsonLD::fetchElement($object, 'diaspora:comment', '@value');
1831 $object_data['diaspora:like'] = JsonLD::fetchElement($object, 'diaspora:like', '@value');
1832 $object_data['actor'] = $object_data['author'] = $actor;
1833 $object_data['context'] = JsonLD::fetchElement($object, 'as:context', '@id');
1834 $object_data['conversation'] = JsonLD::fetchElement($object, 'ostatus:conversation', '@id');
1835 $object_data['sensitive'] = JsonLD::fetchElement($object, 'as:sensitive');
1836 $object_data['name'] = JsonLD::fetchElement($object, 'as:name', '@value');
1837 $object_data['summary'] = JsonLD::fetchElement($object, 'as:summary', '@value');
1838 $object_data['content'] = JsonLD::fetchElement($object, 'as:content', '@value');
1839 $object_data['mediatype'] = JsonLD::fetchElement($object, 'as:mediaType', '@value');
1840 $object_data = self::getSource($object, $object_data);
1841 $object_data['start-time'] = JsonLD::fetchElement($object, 'as:startTime', '@value');
1842 $object_data['end-time'] = JsonLD::fetchElement($object, 'as:endTime', '@value');
1843 $object_data['location'] = $location;
1844 $object_data['latitude'] = JsonLD::fetchElement($object, 'as:location', 'as:latitude', '@type', 'as:Place');
1845 $object_data['latitude'] = JsonLD::fetchElement($object_data, 'latitude', '@value');
1846 $object_data['longitude'] = JsonLD::fetchElement($object, 'as:location', 'as:longitude', '@type', 'as:Place');
1847 $object_data['longitude'] = JsonLD::fetchElement($object_data, 'longitude', '@value');
1848 $object_data['attachments'] = self::processAttachments(JsonLD::fetchElementArray($object, 'as:attachment') ?? []);
1849 $object_data['tags'] = self::processTags(JsonLD::fetchElementArray($object, 'as:tag') ?? []);
1850 $object_data['emojis'] = self::processEmojis(JsonLD::fetchElementArray($object, 'as:tag', null, '@type', 'toot:Emoji') ?? []);
1851 $object_data['languages'] = self::processLanguages(JsonLD::fetchElementArray($object, 'sc:inLanguage') ?? []);
1852 $object_data['generator'] = JsonLD::fetchElement($object, 'as:generator', 'as:name', '@type', 'as:Application');
1853 $object_data['generator'] = JsonLD::fetchElement($object_data, 'generator', '@value');
1854 $object_data['alternate-url'] = JsonLD::fetchElement($object, 'as:url', '@id');
1856 // Special treatment for Hubzilla links
1857 if (is_array($object_data['alternate-url'])) {
1858 $object_data['alternate-url'] = JsonLD::fetchElement($object_data['alternate-url'], 'as:href', '@id');
1860 if (!is_string($object_data['alternate-url'])) {
1861 $object_data['alternate-url'] = JsonLD::fetchElement($object['as:url'], 'as:href', '@id');
1865 if (!empty($object_data['alternate-url']) && !Network::isValidHttpUrl($object_data['alternate-url'])) {
1866 $object_data['alternate-url'] = null;
1869 if (in_array($object_data['object_type'], ['as:Audio', 'as:Video'])) {
1870 $object_data['alternate-url'] = self::extractAlternateUrl($object['as:url'] ?? []) ?: $object_data['alternate-url'];
1871 $object_data['attachments'] = array_merge($object_data['attachments'], self::processAttachmentUrls($object['as:url'] ?? []));
1874 // For page types we expect that the alternate url posts to some page.
1875 // So we add this to the attachments if it differs from the id.
1876 // Currently only Lemmy is using the page type.
1877 if (($object_data['object_type'] == 'as:Page') && !empty($object_data['alternate-url']) && !Strings::compareLink($object_data['alternate-url'], $object_data['id'])) {
1878 $object_data['attachments'][] = ['url' => $object_data['alternate-url']];
1879 $object_data['alternate-url'] = null;
1882 if ($object_data['object_type'] == 'as:Question') {
1883 $object_data['question'] = self::processQuestion($object);
1886 $receiverdata = self::getReceivers($object, $object_data['actor'] ?? '', $object_data['tags'], true);
1887 $receivers = $reception_types = [];
1888 foreach ($receiverdata as $key => $data) {
1889 $receivers[$key] = $data['uid'];
1890 $reception_types[$data['uid']] = $data['type'] ?? 0;
1893 $object_data['receiver_urls'] = self::getReceiverURL($object);
1894 $object_data['receiver'] = $receivers;
1895 $object_data['reception_type'] = $reception_types;
1897 $object_data['unlisted'] = in_array(-1, $object_data['receiver']);
1898 unset($object_data['receiver'][-1]);
1899 unset($object_data['reception_type'][-1]);
1901 return $object_data;
1905 * Add an object id to the list of arrived activities
1911 private static function addArrivedId(string $id)
1913 DBA::delete('arrived-activity', ["`received` < ?", DateTimeFormat::utc('now - 5 minutes')]);
1914 DBA::insert('arrived-activity', ['object-id' => $id, 'received' => DateTimeFormat::utcNow()]);
1918 * Checks if the given object already arrived before
1924 private static function hasArrived(string $id): bool
1926 return DBA::exists('arrived-activity', ['object-id' => $id]);