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\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\Model\Contact;
31 use Friendica\Model\APContact;
32 use Friendica\Model\Item;
33 use Friendica\Model\Post;
34 use Friendica\Model\User;
35 use Friendica\Protocol\Activity;
36 use Friendica\Protocol\ActivityPub;
37 use Friendica\Util\HTTPSignature;
38 use Friendica\Util\JsonLD;
39 use Friendica\Util\LDSignature;
40 use Friendica\Util\Strings;
43 * ActivityPub Receiver Protocol class
48 * Check what this is meant to do:
57 const PUBLIC_COLLECTION = 'as:Public';
58 const ACCOUNT_TYPES = ['as:Person', 'as:Organization', 'as:Service', 'as:Group', 'as:Application'];
59 const CONTENT_TYPES = ['as:Note', 'as:Article', 'as:Video', 'as:Image', 'as:Event', 'as:Audio'];
60 const ACTIVITY_TYPES = ['as:Like', 'as:Dislike', 'as:Accept', 'as:Reject', 'as:TentativeAccept'];
62 const TARGET_UNKNOWN = 0;
67 const TARGET_FOLLOWER = 5;
68 const TARGET_ANSWER = 6;
69 const TARGET_GLOBAL = 7;
72 * Checks incoming message from the inbox
76 * @param integer $uid User ID
79 public static function processInbox($body, $header, $uid)
81 $activity = json_decode($body, true);
82 if (empty($activity)) {
83 Logger::warning('Invalid body.');
87 $ldactivity = JsonLD::compact($activity);
89 $actor = JsonLD::fetchElement($ldactivity, 'as:actor', '@id');
91 $apcontact = APContact::getByURL($actor);
92 if (empty($apcontact)) {
93 Logger::notice('Unable to retrieve AP contact for actor - message is discarded', ['actor' => $actor]);
95 } elseif ($apcontact['type'] == 'Application' && $apcontact['nick'] == 'relay') {
96 self::processRelayPost($ldactivity, $actor);
99 APContact::unmarkForArchival($apcontact);
102 $http_signer = HTTPSignature::getSigner($body, $header);
103 if ($http_signer === false) {
104 Logger::warning('Invalid HTTP signature, message will be discarded.');
106 } elseif (empty($http_signer)) {
107 Logger::info('Signer is a tombstone. The message will be discarded, the signer account is deleted.');
110 Logger::info('Valid HTTP signature', ['signer' => $http_signer]);
113 $signer = [$http_signer];
115 Logger::info('Message for user ' . $uid . ' is from actor ' . $actor);
117 if (LDSignature::isSigned($activity)) {
118 $ld_signer = LDSignature::getSigner($activity);
119 if (empty($ld_signer)) {
120 Logger::log('Invalid JSON-LD signature from ' . $actor, Logger::DEBUG);
121 } elseif ($ld_signer != $http_signer) {
122 $signer[] = $ld_signer;
124 if (!empty($ld_signer && ($actor == $http_signer))) {
125 Logger::log('The HTTP and the JSON-LD signature belong to ' . $ld_signer, Logger::DEBUG);
126 $trust_source = true;
127 } elseif (!empty($ld_signer)) {
128 Logger::log('JSON-LD signature is signed by ' . $ld_signer, Logger::DEBUG);
129 $trust_source = true;
130 } elseif ($actor == $http_signer) {
131 Logger::log('Bad JSON-LD signature, but HTTP signer fits the actor.', Logger::DEBUG);
132 $trust_source = true;
134 Logger::log('Invalid JSON-LD signature and the HTTP signer is different.', Logger::DEBUG);
135 $trust_source = false;
137 } elseif ($actor == $http_signer) {
138 Logger::log('Trusting post without JSON-LD signature, The actor fits the HTTP signer.', Logger::DEBUG);
139 $trust_source = true;
141 Logger::log('No JSON-LD signature, different actor.', Logger::DEBUG);
142 $trust_source = false;
145 self::processActivity($ldactivity, $body, $uid, $trust_source, true, $signer);
149 * Process incoming posts from relays
151 * @param array $activity
152 * @param string $actor
155 private static function processRelayPost(array $activity, string $actor)
157 $type = JsonLD::fetchElement($activity, '@type');
159 Logger::info('Empty type', ['activity' => $activity]);
163 if ($type != 'as:Announce') {
164 Logger::info('Not an announcement', ['activity' => $activity]);
168 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
169 if (empty($object_id)) {
170 Logger::info('No object id found', ['activity' => $activity]);
174 $contact = Contact::getByURL($actor);
175 if (empty($contact)) {
176 Logger::info('Relay contact not found', ['actor' => $actor]);
180 if (!in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND])) {
181 Logger::notice('Relay is no sharer', ['actor' => $actor]);
185 Logger::info('Got relayed message id', ['id' => $object_id]);
187 $item_id = Item::searchByLink($object_id);
189 Logger::info('Relayed message already exists', ['id' => $object_id, 'item' => $item_id]);
193 $id = Processor::fetchMissingActivity($object_id, [], $actor);
195 Logger::notice('Relayed message had not been fetched', ['id' => $object_id]);
199 $item_id = Item::searchByLink($object_id);
201 Logger::info('Relayed message had been fetched and stored', ['id' => $object_id, 'item' => $item_id]);
203 Logger::notice('Relayed message had not been stored', ['id' => $object_id]);
208 * Fetches the object type for a given object id
210 * @param array $activity
211 * @param string $object_id Object ID of the the provided object
212 * @param integer $uid User ID
214 * @return string with object type
215 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
216 * @throws \ImagickException
218 private static function fetchObjectType($activity, $object_id, $uid = 0)
220 if (!empty($activity['as:object'])) {
221 $object_type = JsonLD::fetchElement($activity['as:object'], '@type');
222 if (!empty($object_type)) {
227 if (Post::exists(['uri' => $object_id, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT]])) {
228 // We just assume "note" since it doesn't make a difference for the further processing
232 $profile = APContact::getByURL($object_id);
233 if (!empty($profile['type'])) {
234 APContact::unmarkForArchival($profile);
235 return 'as:' . $profile['type'];
238 $data = ActivityPub::fetchContent($object_id, $uid);
240 $object = JsonLD::compact($data);
241 $type = JsonLD::fetchElement($object, '@type');
251 * Prepare the object array
253 * @param array $activity Array with activity data
254 * @param integer $uid User ID
255 * @param boolean $push Message had been pushed to our system
256 * @param boolean $trust_source Do we trust the source?
258 * @return array with object data
259 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
260 * @throws \ImagickException
262 public static function prepareObjectData($activity, $uid, $push, &$trust_source)
264 $id = JsonLD::fetchElement($activity, '@id');
265 if (!empty($id) && !$trust_source) {
266 $fetched_activity = ActivityPub::fetchContent($id, $uid ?? 0);
267 if (!empty($fetched_activity)) {
268 $object = JsonLD::compact($fetched_activity);
269 $fetched_id = JsonLD::fetchElement($object, '@id');
270 if ($fetched_id == $id) {
271 Logger::info('Activity had been fetched successfully', ['id' => $id]);
272 $trust_source = true;
275 Logger::info('Activity id is not equal', ['id' => $id, 'fetched' => $fetched_id]);
278 Logger::info('Activity could not been fetched', ['id' => $id]);
282 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
284 Logger::info('Empty actor', ['activity' => $activity]);
288 $type = JsonLD::fetchElement($activity, '@type');
290 // Fetch all receivers from to, cc, bto and bcc
291 $receiverdata = self::getReceivers($activity, $actor);
292 $receivers = $reception_types = [];
293 foreach ($receiverdata as $key => $data) {
294 $receivers[$key] = $data['uid'];
295 $reception_types[$data['uid']] = $data['type'] ?? self::TARGET_UNKNOWN;
298 // When it is a delivery to a personal inbox we add that user to the receivers
300 $additional = [$uid => $uid];
301 $receivers = array_replace($receivers, $additional);
302 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]))) {
303 $reception_types[$uid] = self::TARGET_BCC;
306 // We possibly need some user to fetch private content,
307 // so we fetch the first out ot the list.
308 $uid = self::getFirstUserFromReceivers($receivers);
311 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
312 if (empty($object_id)) {
313 Logger::log('No object found', Logger::DEBUG);
317 if (!is_string($object_id)) {
318 Logger::info('Invalid object id', ['object' => $object_id]);
322 $object_type = self::fetchObjectType($activity, $object_id, $uid);
324 // Fetch the content only on activities where this matters
325 // We can receive "#emojiReaction" when fetching content from Hubzilla systems
326 if (in_array($type, ['as:Create', 'as:Update', 'as:Announce']) || strpos($type, '#emojiReaction')) {
327 // Always fetch on "Announce"
328 $object_data = self::fetchObject($object_id, $activity['as:object'], $trust_source && ($type != 'as:Announce'), $uid);
329 if (empty($object_data)) {
330 Logger::log("Object data couldn't be processed", Logger::DEBUG);
334 $object_data['object_id'] = $object_id;
336 if ($type == 'as:Announce') {
337 $object_data['push'] = false;
339 $object_data['push'] = $push;
342 // Test if it is an answer to a mail
343 if (DBA::exists('mail', ['uri' => $object_data['reply-to-id']])) {
344 $object_data['directmessage'] = true;
346 $object_data['directmessage'] = JsonLD::fetchElement($activity, 'litepub:directMessage');
348 } elseif (in_array($type, array_merge(self::ACTIVITY_TYPES, ['as:Follow'])) && in_array($object_type, self::CONTENT_TYPES)) {
349 // Create a mostly empty array out of the activity data (instead of the object).
350 // This way we later don't have to check for the existence of ech individual array element.
351 $object_data = self::processObject($activity);
352 $object_data['name'] = $type;
353 $object_data['author'] = JsonLD::fetchElement($activity, 'as:actor', '@id');
354 $object_data['object_id'] = $object_id;
355 $object_data['object_type'] = ''; // Since we don't fetch the object, we don't know the type
356 $object_data['push'] = $push;
357 } elseif (in_array($type, ['as:Add'])) {
359 $object_data['id'] = JsonLD::fetchElement($activity, '@id');
360 $object_data['target_id'] = JsonLD::fetchElement($activity, 'as:target', '@id');
361 $object_data['object_id'] = JsonLD::fetchElement($activity, 'as:object', '@id');
362 $object_data['object_type'] = JsonLD::fetchElement($activity['as:object'], '@type');
363 $object_data['object_content'] = JsonLD::fetchElement($activity['as:object'], 'as:content', '@type');
364 $object_data['push'] = $push;
367 $object_data['id'] = JsonLD::fetchElement($activity, '@id');
368 $object_data['object_id'] = JsonLD::fetchElement($activity, 'as:object', '@id');
369 $object_data['object_actor'] = JsonLD::fetchElement($activity['as:object'], 'as:actor', '@id');
370 $object_data['object_object'] = JsonLD::fetchElement($activity['as:object'], 'as:object');
371 $object_data['object_type'] = JsonLD::fetchElement($activity['as:object'], '@type');
372 $object_data['push'] = $push;
374 // An Undo is done on the object of an object, so we need that type as well
375 if (($type == 'as:Undo') && !empty($object_data['object_object'])) {
376 $object_data['object_object_type'] = self::fetchObjectType([], $object_data['object_object'], $uid);
380 $object_data = self::addActivityFields($object_data, $activity);
382 if (empty($object_data['object_type'])) {
383 $object_data['object_type'] = $object_type;
386 $object_data['type'] = $type;
387 $object_data['actor'] = $actor;
388 $object_data['item_receiver'] = $receivers;
389 $object_data['receiver'] = array_replace($object_data['receiver'] ?? [], $receivers);
390 $object_data['reception_type'] = array_replace($object_data['reception_type'] ?? [], $reception_types);
392 $author = $object_data['author'] ?? $actor;
393 if (!empty($author) && !empty($object_data['id'])) {
394 $author_host = parse_url($author, PHP_URL_HOST);
395 $id_host = parse_url($object_data['id'], PHP_URL_HOST);
396 if ($author_host == $id_host) {
397 Logger::info('Valid hosts', ['type' => $type, 'host' => $id_host]);
399 Logger::notice('Differing hosts on author and id', ['type' => $type, 'author' => $author_host, 'id' => $id_host]);
400 $trust_source = false;
404 Logger::log('Processing ' . $object_data['type'] . ' ' . $object_data['object_type'] . ' ' . $object_data['id'], Logger::DEBUG);
410 * Fetches the first user id from the receiver array
412 * @param array $receivers Array with receivers
413 * @return integer user id;
415 public static function getFirstUserFromReceivers($receivers)
417 foreach ($receivers as $receiver) {
418 if (!empty($receiver)) {
426 * Processes the activity object
428 * @param array $activity Array with activity data
429 * @param string $body
430 * @param integer $uid User ID
431 * @param boolean $trust_source Do we trust the source?
432 * @param boolean $push Message had been pushed to our system
435 public static function processActivity($activity, string $body = '', int $uid = null, bool $trust_source = false, bool $push = false, array $signer = [])
437 $type = JsonLD::fetchElement($activity, '@type');
439 Logger::info('Empty type', ['activity' => $activity]);
443 if (!JsonLD::fetchElement($activity, 'as:object', '@id')) {
444 Logger::info('Empty object', ['activity' => $activity]);
448 $actor = JsonLD::fetchElement($activity, 'as:actor', '@id');
450 Logger::info('Empty actor', ['activity' => $activity]);
454 if (is_array($activity['as:object'])) {
455 $attributed_to = JsonLD::fetchElement($activity['as:object'], 'as:attributedTo', '@id');
460 // Test the provided signatures against the actor and "attributedTo"
462 if (!empty($attributed_to) && !empty($actor)) {
463 $trust_source = (in_array($actor, $signer) && in_array($attributed_to, $signer));
465 $trust_source = in_array($actor, $signer);
469 // $trust_source is called by reference and is set to true if the content was retrieved successfully
470 $object_data = self::prepareObjectData($activity, $uid, $push, $trust_source);
471 if (empty($object_data)) {
472 Logger::info('No object data found', ['activity' => $activity]);
476 if (!$trust_source) {
477 Logger::info('Activity trust could not be achieved.', ['id' => $object_data['object_id'], 'type' => $type, 'signer' => $signer, 'actor' => $actor, 'attributedTo' => $attributed_to]);
481 if (!empty($body) && empty($object_data['raw'])) {
482 $object_data['raw'] = $body;
485 // Internal flag for thread completion. See Processor.php
486 if (!empty($activity['thread-completion'])) {
487 $object_data['thread-completion'] = $activity['thread-completion'];
490 // Internal flag for posts that arrived via relay
491 if (!empty($activity['from-relay'])) {
492 $object_data['from-relay'] = $activity['from-relay'];
497 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
498 $item = ActivityPub\Processor::createItem($object_data);
499 ActivityPub\Processor::postItem($object_data, $item);
504 if ($object_data['object_type'] == 'as:tag') {
505 ActivityPub\Processor::addTag($object_data);
510 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
511 $object_data['thread-completion'] = Contact::getIdForURL($actor);
513 $item = ActivityPub\Processor::createItem($object_data);
518 $item['post-reason'] = Item::PR_ANNOUNCEMENT;
519 ActivityPub\Processor::postItem($object_data, $item);
521 $announce_object_data = self::processObject($activity);
522 $announce_object_data['name'] = $type;
523 $announce_object_data['author'] = JsonLD::fetchElement($activity, 'as:actor', '@id');
524 $announce_object_data['object_id'] = $object_data['object_id'];
525 $announce_object_data['object_type'] = $object_data['object_type'];
526 $announce_object_data['push'] = $push;
529 $announce_object_data['raw'] = $body;
532 ActivityPub\Processor::createActivity($announce_object_data, Activity::ANNOUNCE);
537 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
538 ActivityPub\Processor::createActivity($object_data, Activity::LIKE);
543 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
544 ActivityPub\Processor::createActivity($object_data, Activity::DISLIKE);
548 case 'as:TentativeAccept':
549 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
550 ActivityPub\Processor::createActivity($object_data, Activity::ATTENDMAYBE);
555 if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
556 ActivityPub\Processor::updateItem($object_data);
557 } elseif (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
558 ActivityPub\Processor::updatePerson($object_data);
563 if ($object_data['object_type'] == 'as:Tombstone') {
564 ActivityPub\Processor::deleteItem($object_data);
565 } elseif (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
566 ActivityPub\Processor::deletePerson($object_data);
571 if (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
572 ActivityPub\Processor::followUser($object_data);
573 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
574 $object_data['reply-to-id'] = $object_data['object_id'];
575 ActivityPub\Processor::createActivity($object_data, Activity::FOLLOW);
580 if ($object_data['object_type'] == 'as:Follow') {
581 ActivityPub\Processor::acceptFollowUser($object_data);
582 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
583 ActivityPub\Processor::createActivity($object_data, Activity::ATTEND);
588 if ($object_data['object_type'] == 'as:Follow') {
589 ActivityPub\Processor::rejectFollowUser($object_data);
590 } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
591 ActivityPub\Processor::createActivity($object_data, Activity::ATTENDNO);
596 if (($object_data['object_type'] == 'as:Follow') &&
597 in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
598 ActivityPub\Processor::undoFollowUser($object_data);
599 } elseif (($object_data['object_type'] == 'as:Accept') &&
600 in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
601 ActivityPub\Processor::rejectFollowUser($object_data);
602 } elseif (in_array($object_data['object_type'], self::ACTIVITY_TYPES) &&
603 in_array($object_data['object_object_type'], self::CONTENT_TYPES)) {
604 ActivityPub\Processor::undoActivity($object_data);
609 Logger::log('Unknown activity: ' . $type . ' ' . $object_data['object_type'], Logger::DEBUG);
615 * Fetch the receiver list from an activity array
617 * @param array $activity
618 * @param string $actor
620 * @param boolean $fetch_unlisted
622 * @return array with receivers (user id)
625 private static function getReceivers($activity, $actor, $tags = [], $fetch_unlisted = false)
627 $reply = $receivers = [];
629 // When it is an answer, we inherite the receivers from the parent
630 $replyto = JsonLD::fetchElement($activity, 'as:inReplyTo', '@id');
631 if (!empty($replyto)) {
634 // Fix possibly wrong item URI (could be an answer to a plink uri)
635 $fixedReplyTo = Item::getURIByLink($replyto);
636 if (!empty($fixedReplyTo)) {
637 $reply[] = $fixedReplyTo;
641 // Fetch all posts that refer to the object id
642 $object_id = JsonLD::fetchElement($activity, 'as:object', '@id');
643 if (!empty($object_id)) {
644 $reply[] = $object_id;
647 if (!empty($reply)) {
648 $parents = Post::select(['uid'], ['uri' => $reply]);
649 while ($parent = Post::fetch($parents)) {
650 $receivers[$parent['uid']] = ['uid' => $parent['uid'], 'type' => self::TARGET_ANSWER];
652 DBA::close($parents);
655 if (!empty($actor)) {
656 $profile = APContact::getByURL($actor);
657 $followers = $profile['followers'] ?? '';
658 $is_forum = ($actor['type'] ?? '') == 'Group';
659 Logger::info('Got actor and followers', ['actor' => $actor, 'followers' => $followers]);
661 Logger::info('Empty actor', ['activity' => $activity]);
666 // We have to prevent false follower assumptions upon thread completions
667 $follower_target = empty($activity['thread-completion']) ? self::TARGET_FOLLOWER : self::TARGET_UNKNOWN;
669 foreach (['as:to', 'as:cc', 'as:bto', 'as:bcc'] as $element) {
670 $receiver_list = JsonLD::fetchElementArray($activity, $element, '@id');
671 if (empty($receiver_list)) {
675 foreach ($receiver_list as $receiver) {
676 if ($receiver == self::PUBLIC_COLLECTION) {
677 $receivers[0] = ['uid' => 0, 'type' => self::TARGET_GLOBAL];
680 // Add receiver "-1" for unlisted posts
681 if ($fetch_unlisted && ($receiver == self::PUBLIC_COLLECTION) && ($element == 'as:cc')) {
682 $receivers[-1] = ['uid' => -1, 'type' => self::TARGET_GLOBAL];
685 // Fetch the receivers for the public and the followers collection
686 if ((($receiver == $followers) || (($receiver == self::PUBLIC_COLLECTION) && !$is_forum)) && !empty($actor)) {
687 $receivers = self::getReceiverForActor($actor, $tags, $receivers, $follower_target);
691 // Fetching all directly addressed receivers
692 $condition = ['self' => true, 'nurl' => Strings::normaliseLink($receiver)];
693 $contact = DBA::selectFirst('contact', ['uid', 'contact-type'], $condition);
694 if (!DBA::isResult($contact)) {
698 // Check if the potential receiver is following the actor
699 // Exception: The receiver is targetted via "to" or this is a comment
700 if ((($element != 'as:to') && empty($replyto)) || ($contact['contact-type'] == Contact::TYPE_COMMUNITY)) {
701 $networks = Protocol::FEDERATED;
702 $condition = ['nurl' => Strings::normaliseLink($actor), 'rel' => [Contact::SHARING, Contact::FRIEND],
703 'network' => $networks, 'archive' => false, 'pending' => false, 'uid' => $contact['uid']];
705 // Forum posts are only accepted from forum contacts
706 if ($contact['contact-type'] == Contact::TYPE_COMMUNITY) {
707 $condition['rel'] = [Contact::SHARING, Contact::FRIEND, Contact::FOLLOWER];
710 if (!DBA::exists('contact', $condition)) {
715 $type = $receivers[$contact['uid']]['type'] ?? self::TARGET_UNKNOWN;
716 if (in_array($type, [self::TARGET_UNKNOWN, self::TARGET_FOLLOWER, self::TARGET_ANSWER, self::TARGET_GLOBAL])) {
719 $type = self::TARGET_TO;
722 $type = self::TARGET_CC;
725 $type = self::TARGET_BTO;
728 $type = self::TARGET_BCC;
732 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $type];
737 self::switchContacts($receivers, $actor);
743 * Fetch the receiver list of a given actor
745 * @param string $actor
747 * @param array $receivers
748 * @param integer $target_type
750 * @return array with receivers (user id)
753 private static function getReceiverForActor($actor, $tags, $receivers, $target_type)
755 $basecondition = ['rel' => [Contact::SHARING, Contact::FRIEND, Contact::FOLLOWER],
756 'network' => Protocol::FEDERATED, 'archive' => false, 'pending' => false];
758 $condition = DBA::mergeConditions($basecondition, ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($actor), 0]);
759 $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
760 while ($contact = DBA::fetch($contacts)) {
761 if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
762 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
765 DBA::close($contacts);
767 // The queries are split because of performance issues
768 $condition = DBA::mergeConditions($basecondition, ["`alias` IN (?, ?) AND `uid` != ?", Strings::normaliseLink($actor), $actor, 0]);
769 $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
770 while ($contact = DBA::fetch($contacts)) {
771 if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
772 $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
775 DBA::close($contacts);
780 * Tests if the contact is a valid receiver for this actor
782 * @param array $contact
783 * @param string $actor
786 * @return bool with receivers (user id)
789 private static function isValidReceiverForActor($contact, $tags)
791 // Are we following the contact? Then this is a valid receiver
792 if (in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND])) {
796 // When the possible receiver isn't a community, then it is no valid receiver
797 $owner = User::getOwnerDataById($contact['uid']);
798 if (empty($owner) || ($owner['contact-type'] != Contact::TYPE_COMMUNITY)) {
802 // Is the community account tagged?
803 foreach ($tags as $tag) {
804 if ($tag['type'] != 'Mention') {
808 if (Strings::compareLink($tag['href'], $owner['url'])) {
817 * Switches existing contacts to ActivityPub
819 * @param integer $cid Contact ID
820 * @param integer $uid User ID
821 * @param string $url Profile URL
822 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
823 * @throws \ImagickException
825 public static function switchContact($cid, $uid, $url)
827 if (DBA::exists('contact', ['id' => $cid, 'network' => Protocol::ACTIVITYPUB])) {
828 Logger::info('Contact is already ActivityPub', ['id' => $cid, 'uid' => $uid, 'url' => $url]);
832 if (Contact::updateFromProbe($cid)) {
833 Logger::info('Update was successful', ['id' => $cid, 'uid' => $uid, 'url' => $url]);
836 // Send a new follow request to be sure that the connection still exists
837 if (($uid != 0) && DBA::exists('contact', ['id' => $cid, 'rel' => [Contact::SHARING, Contact::FRIEND], 'network' => Protocol::ACTIVITYPUB])) {
838 Logger::info('Contact had been switched to ActivityPub. Sending a new follow request.', ['uid' => $uid, 'url' => $url]);
839 ActivityPub\Transmitter::sendActivity('Follow', $url, $uid);
848 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
849 * @throws \ImagickException
851 private static function switchContacts($receivers, $actor)
857 foreach ($receivers as $receiver) {
858 $contact = DBA::selectFirst('contact', ['id'], ['uid' => $receiver['uid'], 'network' => Protocol::OSTATUS, 'nurl' => Strings::normaliseLink($actor)]);
859 if (DBA::isResult($contact)) {
860 self::switchContact($contact['id'], $receiver['uid'], $actor);
863 $contact = DBA::selectFirst('contact', ['id'], ['uid' => $receiver['uid'], 'network' => Protocol::OSTATUS, 'alias' => [Strings::normaliseLink($actor), $actor]]);
864 if (DBA::isResult($contact)) {
865 self::switchContact($contact['id'], $receiver['uid'], $actor);
873 * @param $object_data
874 * @param array $activity
878 private static function addActivityFields($object_data, $activity)
880 if (!empty($activity['published']) && empty($object_data['published'])) {
881 $object_data['published'] = JsonLD::fetchElement($activity, 'as:published', '@value');
884 if (!empty($activity['diaspora:guid']) && empty($object_data['diaspora:guid'])) {
885 $object_data['diaspora:guid'] = JsonLD::fetchElement($activity, 'diaspora:guid', '@value');
888 $object_data['service'] = JsonLD::fetchElement($activity, 'as:instrument', 'as:name', '@type', 'as:Service');
889 $object_data['service'] = JsonLD::fetchElement($object_data, 'service', '@value');
891 if (!empty($object_data['object_id'])) {
892 // Some systems (e.g. GNU Social) don't reply to the "id" field but the "uri" field.
893 $objectId = Item::getURIByLink($object_data['object_id']);
894 if (!empty($objectId) && ($object_data['object_id'] != $objectId)) {
895 Logger::notice('Fix wrong object-id', ['received' => $object_data['object_id'], 'correct' => $objectId]);
896 $object_data['object_id'] = $objectId;
904 * Fetches the object data from external ressources if needed
906 * @param string $object_id Object ID of the the provided object
907 * @param array $object The provided object array
908 * @param boolean $trust_source Do we trust the provided object?
909 * @param integer $uid User ID for the signature that we use to fetch data
911 * @return array|false with trusted and valid object data
912 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
913 * @throws \ImagickException
915 private static function fetchObject(string $object_id, array $object = [], bool $trust_source = false, int $uid = 0)
917 // By fetching the type we check if the object is complete.
918 $type = JsonLD::fetchElement($object, '@type');
920 if (!$trust_source || empty($type)) {
921 $data = ActivityPub::fetchContent($object_id, $uid);
923 $object = JsonLD::compact($data);
924 Logger::log('Fetched content for ' . $object_id, Logger::DEBUG);
926 Logger::log('Empty content for ' . $object_id . ', check if content is available locally.', Logger::DEBUG);
928 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, ['uri' => $object_id]);
929 if (!DBA::isResult($item)) {
930 Logger::log('Object with url ' . $object_id . ' was not found locally.', Logger::DEBUG);
933 Logger::log('Using already stored item for url ' . $object_id, Logger::DEBUG);
934 $data = ActivityPub\Transmitter::createNote($item);
935 $object = JsonLD::compact($data);
938 $id = JsonLD::fetchElement($object, '@id');
940 Logger::info('Empty id');
944 if ($id != $object_id) {
945 Logger::info('Fetched id differs from provided id', ['provided' => $object_id, 'fetched' => $id]);
949 Logger::log('Using original object for url ' . $object_id, Logger::DEBUG);
952 $type = JsonLD::fetchElement($object, '@type');
954 Logger::info('Empty type');
958 // We currently don't handle 'pt:CacheFile', but with this step we avoid logging
959 if (in_array($type, self::CONTENT_TYPES) || ($type == 'pt:CacheFile')) {
960 $object_data = self::processObject($object);
963 $object_data['raw'] = json_encode($data);
968 if ($type == 'as:Announce') {
969 $object_id = JsonLD::fetchElement($object, 'object', '@id');
970 if (empty($object_id) || !is_string($object_id)) {
973 return self::fetchObject($object_id, [], false, $uid);
976 Logger::log('Unhandled object type: ' . $type, Logger::DEBUG);
981 * Converts the language element (Used by Peertube)
983 * @param array $languages
984 * @return array Languages
986 public static function processLanguages(array $languages)
988 if (empty($languages)) {
994 foreach ($languages as $language) {
995 if (!empty($language['_:identifier']) && !empty($language['as:name'])) {
996 $language_list[$language['_:identifier']] = $language['as:name'];
999 return $language_list;
1003 * Convert tags from JSON-LD format into a simplified format
1005 * @param array $tags Tags in JSON-LD format
1007 * @return array with tags in a simplified format
1009 public static function processTags(array $tags)
1013 foreach ($tags as $tag) {
1018 $element = ['type' => str_replace('as:', '', JsonLD::fetchElement($tag, '@type')),
1019 'href' => JsonLD::fetchElement($tag, 'as:href', '@id'),
1020 'name' => JsonLD::fetchElement($tag, 'as:name', '@value')];
1022 if (empty($element['type'])) {
1026 if (empty($element['href'])) {
1027 $element['href'] = $element['name'];
1030 $taglist[] = $element;
1036 * Convert emojis from JSON-LD format into a simplified format
1038 * @param array $emojis
1039 * @return array with emojis in a simplified format
1041 private static function processEmojis(array $emojis)
1045 foreach ($emojis as $emoji) {
1046 if (empty($emoji) || (JsonLD::fetchElement($emoji, '@type') != 'toot:Emoji') || empty($emoji['as:icon'])) {
1050 $url = JsonLD::fetchElement($emoji['as:icon'], 'as:url', '@id');
1051 $element = ['name' => JsonLD::fetchElement($emoji, 'as:name', '@value'),
1054 $emojilist[] = $element;
1061 * Convert attachments from JSON-LD format into a simplified format
1063 * @param array $attachments Attachments in JSON-LD format
1065 * @return array Attachments in a simplified format
1067 private static function processAttachments(array $attachments)
1071 // Removes empty values
1072 $attachments = array_filter($attachments);
1074 foreach ($attachments as $attachment) {
1075 switch (JsonLD::fetchElement($attachment, '@type')) {
1080 $urls = JsonLD::fetchElementArray($attachment, 'as:url');
1081 foreach ($urls as $url) {
1082 // Single scalar URL case
1083 if (is_string($url)) {
1088 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1089 $mediaType = JsonLD::fetchElement($url, 'as:mediaType', '@value');
1090 if (Strings::startsWith($mediaType, 'image')) {
1099 'title' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
1100 'desc' => JsonLD::fetchElement($attachment, 'as:summary', '@value'),
1102 'image' => $pageImage,
1106 $mediaType = JsonLD::fetchElement($attachment, 'as:mediaType', '@value');
1107 $imageFullUrl = JsonLD::fetchElement($attachment, 'as:url', '@id');
1108 $imagePreviewUrl = null;
1110 if (!$imageFullUrl && ($urls = JsonLD::fetchElementArray($attachment, 'as:url'))) {
1111 $imageVariants = [];
1112 $previewVariants = [];
1113 foreach ($urls as $url) {
1114 // Scalar URL, no discrimination possible
1115 if (is_string($url)) {
1116 $imageFullUrl = $url;
1120 // Not sure what to do with a different Link media type than the base Image, we skip
1121 if ($mediaType != JsonLD::fetchElement($url, 'as:mediaType', '@value')) {
1125 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1127 // Default URL choice if no discriminating width is provided
1128 $imageFullUrl = $href ?? $imageFullUrl;
1130 $width = intval(JsonLD::fetchElement($url, 'as:width', '@value') ?? 1);
1132 if ($href && $width) {
1133 $imageVariants[$width] = $href;
1134 // 632 is the ideal width for full screen frio posts, we compute the absolute distance to it
1135 $previewVariants[abs(632 - $width)] = $href;
1139 if ($imageVariants) {
1140 // Taking the maximum size image
1141 ksort($imageVariants);
1142 $imageFullUrl = array_pop($imageVariants);
1144 // Taking the minimum number distance to the target distance
1145 ksort($previewVariants);
1146 $imagePreviewUrl = array_shift($previewVariants);
1149 unset($imageVariants);
1150 unset($previewVariants);
1154 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
1155 'mediaType' => $mediaType,
1156 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
1157 'url' => $imageFullUrl,
1158 'image' => $imagePreviewUrl !== $imageFullUrl ? $imagePreviewUrl : null,
1163 'type' => str_replace('as:', '', JsonLD::fetchElement($attachment, '@type')),
1164 'mediaType' => JsonLD::fetchElement($attachment, 'as:mediaType', '@value'),
1165 'name' => JsonLD::fetchElement($attachment, 'as:name', '@value'),
1166 'url' => JsonLD::fetchElement($attachment, 'as:url', '@id'),
1167 'height' => JsonLD::fetchElement($attachment, 'as:height', '@value'),
1168 'width' => JsonLD::fetchElement($attachment, 'as:width', '@value'),
1169 'image' => JsonLD::fetchElement($attachment, 'as:image', '@id')
1178 * Fetch the original source or content with the "language" Markdown or HTML
1180 * @param array $object
1181 * @param array $object_data
1184 * @throws \Exception
1186 private static function getSource($object, $object_data)
1188 $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/bbcode');
1189 $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
1190 if (!empty($object_data['source'])) {
1191 return $object_data;
1194 $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/markdown');
1195 $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
1196 if (!empty($object_data['source'])) {
1197 $object_data['source'] = Markdown::toBBCode($object_data['source']);
1198 return $object_data;
1201 $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/html');
1202 $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
1203 if (!empty($object_data['source'])) {
1204 $object_data['source'] = HTML::toBBCode($object_data['source']);
1205 return $object_data;
1208 return $object_data;
1212 * Extracts a potential alternate URL from a list of additional URL elements
1214 * @param array $urls
1217 private static function extractAlternateUrl(array $urls): string
1220 foreach ($urls as $key => $url) {
1221 // Not a list but a single URL element
1222 if (!is_numeric($key)) {
1226 if (empty($url['@type']) || ($url['@type'] != 'as:Link')) {
1230 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1235 $mediatype = JsonLD::fetchElement($url, 'as:mediaType');
1236 if (empty($mediatype)) {
1240 if ($mediatype == 'text/html') {
1241 $alternateUrl = $href;
1245 return $alternateUrl;
1249 * Check if the "as:url" element is an array with multiple links
1250 * This is the case with audio and video posts.
1251 * Then the links are added as attachments
1253 * @param array $urls The object URL list
1254 * @return array an array of attachments
1256 private static function processAttachmentUrls(array $urls): array
1259 foreach ($urls as $key => $url) {
1260 // Not a list but a single URL element
1261 if (!is_numeric($key)) {
1265 if (empty($url['@type']) || ($url['@type'] != 'as:Link')) {
1269 $href = JsonLD::fetchElement($url, 'as:href', '@id');
1274 $mediatype = JsonLD::fetchElement($url, 'as:mediaType');
1275 if (empty($mediatype)) {
1279 $filetype = strtolower(substr($mediatype, 0, strpos($mediatype, '/')));
1281 if ($filetype == 'audio') {
1282 $attachments[] = ['type' => $filetype, 'mediaType' => $mediatype, 'url' => $href, 'height' => null, 'size' => null, 'name' => ''];
1283 } elseif ($filetype == 'video') {
1284 $height = (int)JsonLD::fetchElement($url, 'as:height', '@value');
1285 // PeerTube audio-only track
1286 if ($height === 0) {
1290 $size = (int)JsonLD::fetchElement($url, 'pt:size', '@value');
1291 $attachments[] = ['type' => $filetype, 'mediaType' => $mediatype, 'url' => $href, 'height' => $height, 'size' => $size, 'name' => ''];
1292 } elseif (in_array($mediatype, ['application/x-bittorrent', 'application/x-bittorrent;x-scheme-handler/magnet'])) {
1293 $height = (int)JsonLD::fetchElement($url, 'as:height', '@value');
1295 // For Torrent links we always store the highest resolution
1296 if (!empty($attachments[$mediatype]['height']) && ($height < $attachments[$mediatype]['height'])) {
1300 $attachments[$mediatype] = ['type' => $mediatype, 'mediaType' => $mediatype, 'url' => $href, 'height' => $height, 'size' => null, 'name' => ''];
1301 } elseif ($mediatype == 'application/x-mpegURL') {
1302 // PeerTube exception, actual video link is in the tags of this URL element
1303 $attachments = array_merge($attachments, self::processAttachmentUrls($url['as:tag']));
1307 return array_values($attachments);
1311 * Fetches data from the object part of an activity
1313 * @param array $object
1316 * @throws \Exception
1318 private static function processObject($object)
1320 if (!JsonLD::fetchElement($object, '@id')) {
1325 $object_data['object_type'] = JsonLD::fetchElement($object, '@type');
1326 $object_data['id'] = JsonLD::fetchElement($object, '@id');
1327 $object_data['reply-to-id'] = JsonLD::fetchElement($object, 'as:inReplyTo', '@id');
1329 // An empty "id" field is translated to "./" by the compactor, so we have to check for this content
1330 if (empty($object_data['reply-to-id']) || ($object_data['reply-to-id'] == './')) {
1331 $object_data['reply-to-id'] = $object_data['id'];
1333 // Some systems (e.g. GNU Social) don't reply to the "id" field but the "uri" field.
1334 $replyToId = Item::getURIByLink($object_data['reply-to-id']);
1335 if (!empty($replyToId) && ($object_data['reply-to-id'] != $replyToId)) {
1336 Logger::notice('Fix wrong reply-to', ['received' => $object_data['reply-to-id'], 'correct' => $replyToId]);
1337 $object_data['reply-to-id'] = $replyToId;
1341 $object_data['published'] = JsonLD::fetchElement($object, 'as:published', '@value');
1342 $object_data['updated'] = JsonLD::fetchElement($object, 'as:updated', '@value');
1344 if (empty($object_data['updated'])) {
1345 $object_data['updated'] = $object_data['published'];
1348 if (empty($object_data['published']) && !empty($object_data['updated'])) {
1349 $object_data['published'] = $object_data['updated'];
1352 $actor = JsonLD::fetchElement($object, 'as:attributedTo', '@id');
1353 if (empty($actor)) {
1354 $actor = JsonLD::fetchElement($object, 'as:actor', '@id');
1357 $location = JsonLD::fetchElement($object, 'as:location', 'as:name', '@type', 'as:Place');
1358 $location = JsonLD::fetchElement($location, 'location', '@value');
1360 // Some AP software allow formatted text in post location, so we run all the text converters we have to boil
1361 // down to HTML and then finally format to plaintext.
1362 $location = Markdown::convert($location);
1363 $location = BBCode::toPlaintext($location);
1366 $object_data['sc:identifier'] = JsonLD::fetchElement($object, 'sc:identifier', '@value');
1367 $object_data['diaspora:guid'] = JsonLD::fetchElement($object, 'diaspora:guid', '@value');
1368 $object_data['diaspora:comment'] = JsonLD::fetchElement($object, 'diaspora:comment', '@value');
1369 $object_data['diaspora:like'] = JsonLD::fetchElement($object, 'diaspora:like', '@value');
1370 $object_data['actor'] = $object_data['author'] = $actor;
1371 $object_data['context'] = JsonLD::fetchElement($object, 'as:context', '@id');
1372 $object_data['conversation'] = JsonLD::fetchElement($object, 'ostatus:conversation', '@id');
1373 $object_data['sensitive'] = JsonLD::fetchElement($object, 'as:sensitive');
1374 $object_data['name'] = JsonLD::fetchElement($object, 'as:name', '@value');
1375 $object_data['summary'] = JsonLD::fetchElement($object, 'as:summary', '@value');
1376 $object_data['content'] = JsonLD::fetchElement($object, 'as:content', '@value');
1377 $object_data['mediatype'] = JsonLD::fetchElement($object, 'as:mediaType', '@value');
1378 $object_data = self::getSource($object, $object_data);
1379 $object_data['start-time'] = JsonLD::fetchElement($object, 'as:startTime', '@value');
1380 $object_data['end-time'] = JsonLD::fetchElement($object, 'as:endTime', '@value');
1381 $object_data['location'] = $location;
1382 $object_data['latitude'] = JsonLD::fetchElement($object, 'as:location', 'as:latitude', '@type', 'as:Place');
1383 $object_data['latitude'] = JsonLD::fetchElement($object_data, 'latitude', '@value');
1384 $object_data['longitude'] = JsonLD::fetchElement($object, 'as:location', 'as:longitude', '@type', 'as:Place');
1385 $object_data['longitude'] = JsonLD::fetchElement($object_data, 'longitude', '@value');
1386 $object_data['attachments'] = self::processAttachments(JsonLD::fetchElementArray($object, 'as:attachment') ?? []);
1387 $object_data['tags'] = self::processTags(JsonLD::fetchElementArray($object, 'as:tag') ?? []);
1388 $object_data['emojis'] = self::processEmojis(JsonLD::fetchElementArray($object, 'as:tag', null, '@type', 'toot:Emoji') ?? []);
1389 $object_data['languages'] = self::processLanguages(JsonLD::fetchElementArray($object, 'sc:inLanguage') ?? []);
1390 $object_data['generator'] = JsonLD::fetchElement($object, 'as:generator', 'as:name', '@type', 'as:Application');
1391 $object_data['generator'] = JsonLD::fetchElement($object_data, 'generator', '@value');
1392 $object_data['alternate-url'] = JsonLD::fetchElement($object, 'as:url', '@id');
1394 // Special treatment for Hubzilla links
1395 if (is_array($object_data['alternate-url'])) {
1396 $object_data['alternate-url'] = JsonLD::fetchElement($object_data['alternate-url'], 'as:href', '@id');
1398 if (!is_string($object_data['alternate-url'])) {
1399 $object_data['alternate-url'] = JsonLD::fetchElement($object['as:url'], 'as:href', '@id');
1403 if (in_array($object_data['object_type'], ['as:Audio', 'as:Video'])) {
1404 $object_data['alternate-url'] = self::extractAlternateUrl($object['as:url'] ?? []) ?: $object_data['alternate-url'];
1405 $object_data['attachments'] = array_merge($object_data['attachments'], self::processAttachmentUrls($object['as:url'] ?? []));
1408 $receiverdata = self::getReceivers($object, $object_data['actor'], $object_data['tags'], true);
1409 $receivers = $reception_types = [];
1410 foreach ($receiverdata as $key => $data) {
1411 $receivers[$key] = $data['uid'];
1412 $reception_types[$data['uid']] = $data['type'] ?? 0;
1415 $object_data['receiver'] = $receivers;
1416 $object_data['reception_type'] = $reception_types;
1418 $object_data['unlisted'] = in_array(-1, $object_data['receiver']);
1419 unset($object_data['receiver'][-1]);
1420 unset($object_data['reception_type'][-1]);
1422 // Common object data:
1425 // @context, type, actor, signature, mediaType, duration, replies, icon
1427 // Also missing: (Defined in the standard, but currently unused)
1428 // audience, preview, endTime, startTime, image
1433 // contentMap, announcement_count, announcements, context_id, likes, like_count
1434 // inReplyToStatusId, shares, quoteUrl, statusnetConversationId
1439 // category, licence, language, commentsEnabled
1442 // views, waitTranscoding, state, support, subtitleLanguage
1443 // likes, dislikes, shares, comments
1445 return $object_data;