3 * @copyright Copyright (C) 2010-2023, 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;
25 use Friendica\Content\Feature;
26 use Friendica\Content\Text\BBCode;
27 use Friendica\Core\Cache\Enum\Duration;
28 use Friendica\Core\Logger;
29 use Friendica\Core\Protocol;
30 use Friendica\Core\System;
31 use Friendica\Database\DBA;
33 use Friendica\Model\APContact;
34 use Friendica\Model\Contact;
35 use Friendica\Model\GServer;
36 use Friendica\Model\Item;
37 use Friendica\Model\Photo;
38 use Friendica\Model\Post;
39 use Friendica\Model\Tag;
40 use Friendica\Model\User;
41 use Friendica\Network\HTTPException;
42 use Friendica\Protocol\Activity;
43 use Friendica\Protocol\ActivityPub;
44 use Friendica\Protocol\Relay;
45 use Friendica\Util\DateTimeFormat;
46 use Friendica\Util\HTTPSignature;
47 use Friendica\Util\LDSignature;
48 use Friendica\Util\Map;
49 use Friendica\Util\Network;
50 use Friendica\Util\Strings;
51 use Friendica\Util\XML;
54 * ActivityPub Transmitter Protocol class
61 const CACHEKEY_FEATURED = 'transmitter:getFeatured:';
62 const CACHEKEY_CONTACTS = 'transmitter:getContacts:';
65 * Add relay servers to the list of inboxes
67 * @param array $inboxes
68 * @return array inboxes with added relay servers
70 public static function addRelayServerInboxes(array $inboxes = []): array
72 foreach (Relay::getList(['inbox']) as $contact) {
73 $inboxes[$contact['inbox']] = $contact['inbox'];
80 * Add relay servers to the list of inboxes
82 * @param array $inboxes
83 * @return array inboxes with added relay servers
85 public static function addRelayServerInboxesForItem(int $item_id, array $inboxes = []): array
87 $item = Post::selectFirst(['uid'], ['id' => $item_id]);
92 $relays = Relay::getDirectRelayList($item_id);
97 foreach ($relays as $relay) {
98 $contact = Contact::getByURLForUser($relay['url'], $item['uid'], false, ['id']);
99 $inboxes[$relay['batch']][] = $contact['id'] ?? 0;
105 * Subscribe to a relay and updates contact on success
107 * @param string $url Subscribe actor url
108 * @return bool success
110 public static function sendRelayFollow(string $url): bool
112 $contact = Contact::getByURL($url);
113 if (empty($contact)) {
117 $activity_id = self::activityIDFromContact($contact['id']);
118 $success = self::sendActivity('Follow', $url, 0, $activity_id);
120 Contact::update(['rel' => Contact::FRIEND], ['id' => $contact['id']]);
127 * Unsubscribe from a relay and updates contact on success or forced
129 * @param string $url Subscribe actor url
130 * @param bool $force Set the relay status as non follower even if unsubscribe hadn't worked
131 * @return bool success
133 public static function sendRelayUndoFollow(string $url, bool $force = false): bool
135 $contact = Contact::getByURL($url);
136 if (empty($contact)) {
140 $success = self::sendContactUndo($url, $contact['id'], User::getSystemAccount());
142 if ($success || $force) {
143 Contact::update(['rel' => Contact::NOTHING], ['id' => $contact['id']]);
150 * Collects a list of contacts of the given owner
152 * @param array $owner Owner array
153 * @param array $rel The relevant value(s) contact.rel should match
154 * @param string $module The name of the relevant AP endpoint module (followers|following)
155 * @param integer $page Page number
156 * @param string $requester URL of the requester
157 * @param boolean $nocache Wether to bypass caching
158 * @return array of owners
161 public static function getContacts(array $owner, array $rel, string $module, int $page = null, string $requester = null, bool $nocache = false): array
164 $cachekey = self::CACHEKEY_CONTACTS . $module . ':'. $owner['uid'];
165 $result = DI::cache()->get($cachekey);
166 if (!$nocache && !is_null($result)) {
173 'uid' => $owner['uid'],
182 $condition = DBA::mergeConditions($parameters, ["`url` IN (SELECT `url` FROM `apcontact`)"]);
184 $total = DBA::count('contact', $condition);
186 $modulePath = '/' . $module . '/';
188 $data = ['@context' => ActivityPub::CONTEXT];
189 $data['id'] = DI::baseUrl() . $modulePath . $owner['nickname'];
190 $data['type'] = 'OrderedCollection';
191 $data['totalItems'] = $total;
194 $data['id'] .= '?' . http_build_query(['page' => $page]);
197 // When we hide our friends we will only show the pure number but don't allow more.
198 $show_contacts = empty($owner['hide-friends']);
200 // Allow fetching the contact list when the requester is part of the list.
201 if (($owner['page-flags'] == User::PAGE_FLAGS_PRVGROUP) && !empty($requester)) {
202 $show_contacts = DBA::exists('contact', ['nurl' => Strings::normaliseLink($requester), 'uid' => $owner['uid'], 'blocked' => false]);
205 if (!$show_contacts) {
206 if (!empty($cachekey)) {
207 DI::cache()->set($cachekey, $data, Duration::DAY);
214 $data['first'] = DI::baseUrl() . $modulePath . $owner['nickname'] . '?page=1';
216 $data['type'] = 'OrderedCollectionPage';
219 $contacts = DBA::select('contact', ['url'], $condition, ['limit' => [($page - 1) * 100, 100]]);
220 while ($contact = DBA::fetch($contacts)) {
221 $list[] = $contact['url'];
223 DBA::close($contacts);
225 if (count($list) == 100) {
226 $data['next'] = DI::baseUrl() . $modulePath . $owner['nickname'] . '?page=' . ($page + 1);
229 $data['partOf'] = DI::baseUrl() . $modulePath . $owner['nickname'];
231 $data['orderedItems'] = $list;
234 if (!empty($cachekey)) {
235 DI::cache()->set($cachekey, $data, Duration::DAY);
242 * Public posts for the given owner
244 * @param array $owner Owner array
245 * @param integer $page Page number
246 * @param boolean $nocache Wether to bypass caching
248 * @return array of posts
249 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
250 * @throws \ImagickException
252 public static function getFeatured(array $owner, int $page = null, bool $nocache = false): array
255 $cachekey = self::CACHEKEY_FEATURED . $owner['uid'];
256 $result = DI::cache()->get($cachekey);
257 if (!$nocache && !is_null($result)) {
262 $owner_cid = Contact::getIdForURL($owner['url'], 0, false);
264 $condition = ["`uri-id` IN (SELECT `uri-id` FROM `collection-view` WHERE `cid` = ? AND `type` = ?)",
265 $owner_cid, Post\Collection::FEATURED];
267 $condition = DBA::mergeConditions($condition, [
268 'uid' => $owner['uid'],
269 'author-id' => $owner_cid,
270 'private' => [Item::PUBLIC, Item::UNLISTED],
271 'gravity' => [Item::GRAVITY_PARENT, Item::GRAVITY_COMMENT],
272 'network' => Protocol::FEDERATED,
273 'parent-network' => Protocol::FEDERATED,
279 $count = Post::count($condition);
281 $data = ['@context' => ActivityPub::CONTEXT];
282 $data['id'] = DI::baseUrl() . '/featured/' . $owner['nickname'];
283 $data['type'] = 'OrderedCollection';
284 $data['totalItems'] = $count;
287 $data['id'] .= '?' . http_build_query(['page' => $page]);
291 $items = Post::select(['id'], $condition, ['limit' => 20, 'order' => ['created' => true]]);
293 $data['type'] = 'OrderedCollectionPage';
294 $items = Post::select(['id'], $condition, ['limit' => [($page - 1) * 20, 20], 'order' => ['created' => true]]);
298 while ($item = Post::fetch($items)) {
299 $activity = self::createActivityFromItem($item['id'], true);
300 if (!empty($activity)) {
306 if (count($list) == 20) {
307 $data['next'] = DI::baseUrl() . '/featured/' . $owner['nickname'] . '?page=' . ($page + 1);
311 $data['partOf'] = DI::baseUrl() . '/featured/' . $owner['nickname'];
314 $data['orderedItems'] = $list;
316 if (!empty($cachekey)) {
317 DI::cache()->set($cachekey, $data, Duration::DAY);
324 * Return the service array containing information the used software and it's url
326 * @return array with service data
328 public static function getService(): array
332 'name' => App::PLATFORM . " '" . App::CODENAME . "' " . App::VERSION . '-' . DB_UPDATE_VERSION,
333 'url' => DI::baseUrl()->get()
338 * Return the ActivityPub profile of the given user
340 * @param int $uid User ID
341 * @return array with profile data
342 * @throws HTTPException\NotFoundException
343 * @throws HTTPException\InternalServerErrorException
345 public static function getProfile(int $uid): array
347 $owner = User::getOwnerDataById($uid);
348 if (!isset($owner['id'])) {
349 DI::logger()->error('Unable to find owner data for uid', ['uid' => $uid, 'callstack' => System::callstack(20)]);
350 throw new HTTPException\NotFoundException('User not found.');
353 $data = ['@context' => ActivityPub::CONTEXT];
354 $data['id'] = $owner['url'];
356 if (!empty($owner['guid'])) {
357 $data['diaspora:guid'] = $owner['guid'];
360 $data['type'] = ActivityPub::ACCOUNT_TYPES[$owner['account-type']];
363 $data['following'] = DI::baseUrl() . '/following/' . $owner['nick'];
364 $data['followers'] = DI::baseUrl() . '/followers/' . $owner['nick'];
365 $data['inbox'] = DI::baseUrl() . '/inbox/' . $owner['nick'];
366 $data['outbox'] = DI::baseUrl() . '/outbox/' . $owner['nick'];
367 $data['featured'] = DI::baseUrl() . '/featured/' . $owner['nick'];
369 $data['inbox'] = DI::baseUrl() . '/friendica/inbox';
372 $data['preferredUsername'] = $owner['nick'];
373 $data['name'] = $owner['name'];
375 if (!empty($owner['country-name'] . $owner['region'] . $owner['locality'])) {
376 $data['vcard:hasAddress'] = ['@type' => 'vcard:Home', 'vcard:country-name' => $owner['country-name'],
377 'vcard:region' => $owner['region'], 'vcard:locality' => $owner['locality']];
380 if (!empty($owner['about'])) {
381 $data['summary'] = BBCode::convertForUriId($owner['uri-id'] ?? 0, $owner['about'], BBCode::EXTERNAL);
384 if (!empty($owner['xmpp']) || !empty($owner['matrix'])) {
385 $data['vcard:hasInstantMessage'] = [];
387 if (!empty($owner['xmpp'])) {
388 $data['vcard:hasInstantMessage'][] = 'xmpp:' . $owner['xmpp'];
390 if (!empty($owner['matrix'])) {
391 $data['vcard:hasInstantMessage'][] = 'matrix:' . $owner['matrix'];
395 $data['url'] = $owner['url'];
396 $data['manuallyApprovesFollowers'] = in_array($owner['page-flags'], [User::PAGE_FLAGS_NORMAL, User::PAGE_FLAGS_PRVGROUP]);
397 $data['discoverable'] = (bool)$owner['net-publish'];
398 $data['publicKey'] = ['id' => $owner['url'] . '#main-key',
399 'owner' => $owner['url'],
400 'publicKeyPem' => $owner['pubkey']];
401 $data['endpoints'] = ['sharedInbox' => DI::baseUrl() . '/inbox'];
403 $data['icon'] = ['type' => 'Image', 'url' => User::getAvatarUrl($owner)];
405 $resourceid = Photo::ridFromURI($owner['photo']);
406 if (!empty($resourceid)) {
407 $photo = Photo::selectFirst(['type'], ["resource-id" => $resourceid]);
408 if (!empty($photo['type'])) {
409 $data['icon']['mediaType'] = $photo['type'];
413 if (!empty($owner['header'])) {
414 $data['image'] = ['type' => 'Image', 'url' => Contact::getHeaderUrlForId($owner['id'], '', $owner['updated'])];
416 $resourceid = Photo::ridFromURI($owner['header']);
417 if (!empty($resourceid)) {
418 $photo = Photo::selectFirst(['type'], ["resource-id" => $resourceid]);
419 if (!empty($photo['type'])) {
420 $data['image']['mediaType'] = $photo['type'];
427 foreach (DI::profileField()->selectByContactId(0, $uid) as $profile_field) {
429 'type' => 'PropertyValue',
430 'name' => $profile_field->label,
431 'value' => BBCode::convertForUriId($owner['uri-id'], $profile_field->value)
435 if (!empty($custom_fields)) {
436 $data['attachment'] = $custom_fields;
440 $data['generator'] = self::getService();
442 // tags: https://kitty.town/@inmysocks/100656097926961126.json
447 * Get a minimal actror array for the C2S API
449 * @param integer $cid
452 private static function getActorArrayByCid(int $cid): array
454 $contact = Contact::getById($cid);
456 'id' => $contact['url'],
457 'type' => $data['type'] = ActivityPub::ACCOUNT_TYPES[$contact['contact-type']],
458 'url' => $contact['alias'],
459 'preferredUsername' => $contact['nick'],
460 'name' => $contact['name'],
461 'icon' => ['type' => 'Image', 'url' => Contact::getAvatarUrlForId($cid, '', $contact['updated'])],
462 'image' => ['type' => 'Image', 'url' => Contact::getHeaderUrlForId($cid, '', $contact['updated'])],
463 'manuallyApprovesFollowers' => (bool)$contact['manually-approve'],
464 'discoverable' => !$contact['unsearchable'],
467 if (empty($data['url'])) {
468 $data['url'] = $data['id'];
475 * @param string $username
477 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
479 public static function getDeletedUser(string $username): array
482 '@context' => ActivityPub::CONTEXT,
483 'id' => DI::baseUrl() . '/profile/' . $username,
484 'type' => 'Tombstone',
485 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
486 'updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
487 'deleted' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
492 * Returns an array with permissions of the thread parent of the given item array
495 * @param bool $is_forum_thread
497 * @return array with permissions
498 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
499 * @throws \ImagickException
501 private static function fetchPermissionBlockFromThreadParent(array $item, bool $is_forum_thread): array
503 if (empty($item['thr-parent-id'])) {
507 $parent = Post::selectFirstPost(['author-link'], ['uri-id' => $item['thr-parent-id']]);
508 if (empty($parent)) {
513 'to' => [$parent['author-link']],
519 $parent_profile = APContact::getByURL($parent['author-link']);
521 $item_profile = APContact::getByURL($item['author-link']);
522 $exclude[] = $item['author-link'];
524 if ($item['gravity'] == Item::GRAVITY_PARENT) {
525 $exclude[] = $item['owner-link'];
528 $type = [Tag::TO => 'to', Tag::CC => 'cc', Tag::BTO => 'bto', Tag::BCC => 'bcc'];
529 foreach (Tag::getByURIId($item['thr-parent-id'], [Tag::TO, Tag::CC, Tag::BTO, Tag::BCC]) as $receiver) {
530 if (!empty($parent_profile['followers']) && $receiver['url'] == $parent_profile['followers'] && !empty($item_profile['followers'])) {
531 if (!$is_forum_thread) {
532 $permissions[$type[$receiver['type']]][] = $item_profile['followers'];
534 } elseif (!in_array($receiver['url'], $exclude)) {
535 $permissions[$type[$receiver['type']]][] = $receiver['url'];
543 * Check if the given item id is from ActivityPub
545 * @param integer $item_id
546 * @return boolean "true" if the post is from ActivityPub
548 private static function isAPPost(int $item_id): bool
550 if (empty($item_id)) {
554 return Post::exists(['id' => $item_id, 'network' => Protocol::ACTIVITYPUB]);
558 * Creates an array of permissions from an item thread
560 * @param array $item Item array
561 * @param boolean $blindcopy addressing via "bcc" or "cc"?
562 * @param integer $last_id Last item id for adding receivers
564 * @return array with permission data
565 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
566 * @throws \ImagickException
568 private static function createPermissionBlockForItem(array $item, bool $blindcopy, int $last_id = 0): array
571 $last_id = $item['id'];
578 // Check if we should always deliver our stuff via BCC
579 if (!empty($item['uid'])) {
580 $owner = User::getOwnerDataById($item['uid']);
581 if (!empty($owner)) {
582 $always_bcc = $owner['hide-friends'];
583 $is_forum = ($owner['account-type'] == User::ACCOUNT_TYPE_COMMUNITY) && $owner['manually-approve'];
585 $profile = APContact::getByURL($owner['url'], false);
586 $follower = $profile['followers'] ?? '';
590 if (DI::config()->get('system', 'ap_always_bcc')) {
594 $parent = Post::selectFirst(['causer-link', 'post-reason'], ['id' => $item['parent']]);
595 if (!empty($parent) && ($parent['post-reason'] == Item::PR_ANNOUNCEMENT) && !empty($parent['causer-link'])) {
596 $profile = APContact::getByURL($parent['causer-link'], false);
597 $is_forum_thread = isset($profile['type']) && $profile['type'] == 'Group';
599 $is_forum_thread = false;
602 if (self::isAnnounce($item) || self::isAPPost($last_id)) {
603 // Will be activated in a later step
604 $networks = Protocol::FEDERATED;
606 // For now only send to these contacts:
607 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
610 $data = ['to' => [], 'cc' => [], 'bcc' => []];
612 if ($item['gravity'] == Item::GRAVITY_PARENT) {
613 $actor_profile = APContact::getByURL($item['owner-link']);
615 $actor_profile = APContact::getByURL($item['author-link']);
621 if ($is_forum_thread) {
622 foreach (Tag::getByURIId($item['parent-uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]) as $term) {
623 $profile = APContact::getByURL($term['url'], false);
624 if (!empty($profile) && ($profile['type'] == 'Group')) {
625 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
627 } elseif ($term['type'] == Tag::MENTION) {
634 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
636 if ($item['private'] != Item::PRIVATE) {
637 // Directly mention the original author upon a quoted reshare.
638 // Else just ensure that the original author receives the reshare.
639 $announce = self::getAnnounceArray($item);
640 if (!empty($announce['comment'])) {
641 $data['to'][] = $announce['actor']['url'];
642 } elseif (!empty($announce)) {
643 $data['cc'][] = $announce['actor']['url'];
646 $data = array_merge($data, self::fetchPermissionBlockFromThreadParent($item, $is_forum_thread));
648 // Check if the item is completely public or unlisted
649 if ($item['private'] == Item::PUBLIC) {
650 $data['to'][] = ActivityPub::PUBLIC_COLLECTION;
652 $data['cc'][] = ActivityPub::PUBLIC_COLLECTION;
655 foreach ($terms as $term) {
656 $profile = APContact::getByURL($term['url'], false);
657 if (!empty($profile)) {
658 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
660 if (!empty($profile['followers']) && ($profile['type'] == 'Group')) {
661 $data['cc'][] = $profile['followers'];
663 } elseif (($term['type'] == Tag::MENTION) && ($profile['type'] == 'Group')) {
666 $data['to'][] = $profile['url'];
670 $receiver_list = Item::enumeratePermissions($item, true);
672 foreach ($terms as $term) {
673 $cid = Contact::getIdForURL($term['url'], $item['uid']);
674 if (!empty($cid) && in_array($cid, $receiver_list)) {
675 $contact = DBA::selectFirst('contact', ['url', 'network', 'protocol', 'gsid'], ['id' => $cid, 'network' => Protocol::FEDERATED]);
676 if (!DBA::isResult($contact) || !self::isAPContact($contact, $networks)) {
680 $profile = APContact::getByURL($term['url'], false);
681 if (!empty($profile)) {
682 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
684 if (!empty($profile['followers']) && ($profile['type'] == 'Group')) {
685 $data['cc'][] = $profile['followers'];
687 } elseif (($term['type'] == Tag::MENTION) && ($profile['type'] == 'Group')) {
690 $data['to'][] = $profile['url'];
699 if ($is_forum && !$exclusive && !empty($follower)) {
700 $data['cc'][] = $follower;
701 } elseif (!$exclusive) {
702 foreach ($receiver_list as $receiver) {
703 $contact = DBA::selectFirst('contact', ['url', 'hidden', 'network', 'protocol', 'gsid'], ['id' => $receiver, 'network' => Protocol::FEDERATED]);
704 if (!DBA::isResult($contact) || !self::isAPContact($contact, $networks)) {
708 if (!empty($profile = APContact::getByURL($contact['url'], false))) {
709 if ($contact['hidden'] || $always_bcc) {
710 $data['bcc'][] = $profile['url'];
712 $data['cc'][] = $profile['url'];
719 if (!empty($item['parent'])) {
720 $parents = Post::select(['id', 'author-link', 'owner-link', 'gravity', 'uri'], ['parent' => $item['parent']], ['order' => ['id']]);
721 while ($parent = Post::fetch($parents)) {
722 if ($parent['gravity'] == Item::GRAVITY_PARENT) {
723 $profile = APContact::getByURL($parent['owner-link'], false);
724 if (!empty($profile)) {
725 if ($item['gravity'] != Item::GRAVITY_PARENT) {
726 // Comments to forums are directed to the forum
727 // But comments to forums aren't directed to the followers collection
728 // This rule is only valid when the actor isn't the forum.
729 // The forum needs to transmit their content to their followers.
730 if (($profile['type'] == 'Group') && ($profile['url'] != ($actor_profile['url'] ?? ''))) {
731 $data['to'][] = $profile['url'];
733 $data['cc'][] = $profile['url'];
734 if (($item['private'] != Item::PRIVATE) && !empty($actor_profile['followers']) && (!$exclusive || !$is_forum_thread)) {
735 $data['cc'][] = $actor_profile['followers'];
738 } elseif (!$exclusive && !$is_forum_thread) {
739 // Public thread parent post always are directed to the followers.
740 if ($item['private'] != Item::PRIVATE) {
741 $data['cc'][] = $actor_profile['followers'];
747 // Don't include data from future posts
748 if ($parent['id'] >= $last_id) {
752 $profile = APContact::getByURL($parent['author-link'], false);
753 if (!empty($profile)) {
754 if (($profile['type'] == 'Group') || ($parent['uri'] == $item['thr-parent'])) {
755 $data['to'][] = $profile['url'];
757 $data['cc'][] = $profile['url'];
761 DBA::close($parents);
764 $data['to'] = array_unique($data['to']);
765 $data['cc'] = array_unique($data['cc']);
766 $data['bcc'] = array_unique($data['bcc']);
768 if (($key = array_search($item['author-link'], $data['to'])) !== false) {
769 unset($data['to'][$key]);
772 if (($key = array_search($item['author-link'], $data['cc'])) !== false) {
773 unset($data['cc'][$key]);
776 if (($key = array_search($item['author-link'], $data['bcc'])) !== false) {
777 unset($data['bcc'][$key]);
780 foreach ($data['to'] as $to) {
781 if (($key = array_search($to, $data['cc'])) !== false) {
782 unset($data['cc'][$key]);
785 if (($key = array_search($to, $data['bcc'])) !== false) {
786 unset($data['bcc'][$key]);
790 foreach ($data['cc'] as $cc) {
791 if (($key = array_search($cc, $data['bcc'])) !== false) {
792 unset($data['bcc'][$key]);
796 $receivers = ['to' => array_values($data['to']), 'cc' => array_values($data['cc']), 'bcc' => array_values($data['bcc'])];
799 unset($receivers['bcc']);
802 foreach (['to' => Tag::TO, 'cc' => Tag::CC, 'bcc' => Tag::BCC] as $element => $type) {
803 if (!empty($receivers[$element])) {
804 foreach ($receivers[$element] as $receiver) {
805 if ($receiver == ActivityPub::PUBLIC_COLLECTION) {
806 $name = Receiver::PUBLIC_COLLECTION;
808 $name = trim(parse_url($receiver, PHP_URL_PATH), '/');
810 Tag::store($item['uri-id'], $type, $name, $receiver);
819 * Check if an inbox is archived
821 * @param string $url Inbox url
822 * @return boolean "true" if inbox is archived
824 public static function archivedInbox(string $url): bool
826 return DBA::exists('inbox-status', ['url' => $url, 'archive' => true]);
830 * Check if a given contact should be delivered via AP
832 * @param array $contact Contact array
833 * @param array $networks Array with networks
834 * @return bool Whether the used protocol matches ACTIVITYPUB
837 private static function isAPContact(array $contact, array $networks): bool
839 if (in_array($contact['network'], $networks) || ($contact['protocol'] == Protocol::ACTIVITYPUB)) {
843 return GServer::getProtocol($contact['gsid'] ?? 0) == Post\DeliveryData::ACTIVITYPUB;
847 * Fetches a list of inboxes of followers of a given user
849 * @param integer $uid User ID
850 * @param boolean $personal fetch personal inboxes
851 * @param boolean $all_ap Retrieve all AP enabled inboxes
852 * @return array of follower inboxes
853 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
854 * @throws \ImagickException
856 public static function fetchTargetInboxesforUser(int $uid, bool $personal = false, bool $all_ap = false): array
862 if (!empty($item['uid'])) {
863 $profile = User::getOwnerDataById($item['uid']);
864 if (!empty($profile)) {
865 $isforum = $profile['account-type'] == User::ACCOUNT_TYPE_COMMUNITY;
870 // Will be activated in a later step
871 $networks = Protocol::FEDERATED;
873 // For now only send to these contacts:
874 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
882 'network' => Protocol::FEDERATED,
886 $condition['rel'] = [Contact::FOLLOWER, Contact::FRIEND];
889 $contacts = DBA::select('contact', ['id', 'url', 'network', 'protocol', 'gsid'], $condition);
890 while ($contact = DBA::fetch($contacts)) {
891 if (!self::isAPContact($contact, $networks)) {
895 if ($isforum && ($contact['network'] == Protocol::DFRN)) {
899 if (Network::isUrlBlocked($contact['url'])) {
903 $profile = APContact::getByURL($contact['url'], false);
904 if (!empty($profile)) {
905 if (empty($profile['sharedinbox']) || $personal || Contact::isLocal($contact['url'])) {
906 $target = $profile['inbox'];
908 $target = $profile['sharedinbox'];
910 if (!self::archivedInbox($target)) {
911 $inboxes[$target][] = $contact['id'];
915 DBA::close($contacts);
921 * Fetches an array of inboxes for the given item and user
923 * @param array $item Item array
924 * @param integer $uid User ID
925 * @param boolean $personal fetch personal inboxes
926 * @param integer $last_id Last item id for adding receivers
927 * @return array with inboxes
928 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
929 * @throws \ImagickException
931 public static function fetchTargetInboxes(array $item, int $uid, bool $personal = false, int $last_id = 0): array
933 $permissions = self::createPermissionBlockForItem($item, true, $last_id);
934 if (empty($permissions)) {
940 if ($item['gravity'] == Item::GRAVITY_ACTIVITY) {
941 $item_profile = APContact::getByURL($item['author-link'], false);
943 $item_profile = APContact::getByURL($item['owner-link'], false);
946 if (empty($item_profile)) {
950 $profile_uid = User::getIdForURL($item_profile['url']);
952 foreach (['to', 'cc', 'bto', 'bcc'] as $element) {
953 if (empty($permissions[$element])) {
957 $blindcopy = in_array($element, ['bto', 'bcc']);
959 foreach ($permissions[$element] as $receiver) {
960 if (empty($receiver) || Network::isUrlBlocked($receiver)) {
964 if ($item_profile && ($receiver == $item_profile['followers']) && ($uid == $profile_uid)) {
965 $inboxes = array_merge($inboxes, self::fetchTargetInboxesforUser($uid, $personal, self::isAPPost($last_id)));
967 $profile = APContact::getByURL($receiver, false);
968 if (!empty($profile)) {
969 $contact = Contact::getByURLForUser($receiver, $uid, false, ['id']);
971 if (empty($profile['sharedinbox']) || $personal || $blindcopy || Contact::isLocal($receiver)) {
972 $target = $profile['inbox'];
974 $target = $profile['sharedinbox'];
976 if (!self::archivedInbox($target)) {
977 $inboxes[$target][] = $contact['id'] ?? 0;
988 * Creates an array in the structure of the item table for a given mail id
990 * @param integer $mail_id Mail id
994 public static function getItemArrayFromMail(int $mail_id, bool $use_title = false): array
996 $mail = DBA::selectFirst('mail', [], ['id' => $mail_id]);
997 if (!DBA::isResult($mail)) {
1001 $reply = DBA::selectFirst('mail', ['uri', 'uri-id', 'from-url'], ['parent-uri' => $mail['parent-uri'], 'reply' => false]);
1002 if (!DBA::isResult($reply)) {
1006 // Making the post more compatible for Mastodon by:
1007 // - Making it a note and not an article (no title)
1008 // - Moving the title into the "summary" field that is used as a "content warning"
1011 $mail['body'] = '[abstract]' . $mail['title'] . "[/abstract]\n" . $mail['body'];
1012 $mail['title'] = '';
1015 $mail['content-warning'] = '';
1016 $mail['author-link'] = $mail['owner-link'] = $mail['from-url'];
1017 $mail['owner-id'] = $mail['author-id'];
1018 $mail['allow_cid'] = '<'.$mail['contact-id'].'>';
1019 $mail['allow_gid'] = '';
1020 $mail['deny_cid'] = '';
1021 $mail['deny_gid'] = '';
1022 $mail['private'] = Item::PRIVATE;
1023 $mail['deleted'] = false;
1024 $mail['edited'] = $mail['created'];
1025 $mail['plink'] = DI::baseUrl() . '/message/' . $mail['id'];
1026 $mail['parent-uri'] = $reply['uri'];
1027 $mail['parent-uri-id'] = $reply['uri-id'];
1028 $mail['parent-author-id'] = Contact::getIdForURL($reply['from-url'], 0, false);
1029 $mail['gravity'] = ($mail['reply'] ? Item::GRAVITY_COMMENT: Item::GRAVITY_PARENT);
1030 $mail['event-type'] = '';
1031 $mail['language'] = '';
1032 $mail['parent'] = 0;
1038 * Creates an activity array for a given mail id
1040 * @param integer $mail_id
1041 * @param boolean $object_mode Is the activity item is used inside another object?
1043 * @return array of activity
1044 * @throws \Exception
1046 public static function createActivityFromMail(int $mail_id, bool $object_mode = false): array
1048 $mail = self::getItemArrayFromMail($mail_id);
1052 $object = self::createNote($mail);
1054 if (!$object_mode) {
1055 $data = ['@context' => ActivityPub::CONTEXT];
1060 $data['id'] = $mail['uri'] . '/Create';
1061 $data['type'] = 'Create';
1062 $data['actor'] = $mail['author-link'];
1063 $data['published'] = DateTimeFormat::utc($mail['created'] . '+00:00', DateTimeFormat::ATOM);
1064 $data['instrument'] = self::getService();
1065 $data = array_merge($data, self::createPermissionBlockForItem($mail, true));
1067 if (empty($data['to']) && !empty($data['cc'])) {
1068 $data['to'] = $data['cc'];
1071 if (empty($data['to']) && !empty($data['bcc'])) {
1072 $data['to'] = $data['bcc'];
1076 unset($data['bcc']);
1078 $object['to'] = $data['to'];
1079 $object['tag'] = [['type' => 'Mention', 'href' => $object['to'][0], 'name' => '']];
1081 unset($object['cc']);
1082 unset($object['bcc']);
1084 $data['directMessage'] = true;
1086 $data['object'] = $object;
1088 $owner = User::getOwnerDataById($mail['uid']);
1090 if (!$object_mode && !empty($owner)) {
1091 return LDSignature::sign($data, $owner);
1098 * Returns the activity type of a given item
1100 * @param array $item Item array
1101 * @return string with activity type
1102 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1103 * @throws \ImagickException
1105 private static function getTypeOfItem(array $item): string
1109 // Only check for a reshare, if it is a real reshare and no quoted reshare
1110 if (strpos($item['body'], '[share') === 0) {
1111 $announce = self::getAnnounceArray($item);
1112 $reshared = !empty($announce);
1117 } elseif ($item['verb'] == Activity::POST) {
1118 if ($item['created'] == $item['edited']) {
1123 } elseif ($item['verb'] == Activity::LIKE) {
1125 } elseif ($item['verb'] == Activity::DISLIKE) {
1127 } elseif ($item['verb'] == Activity::ATTEND) {
1129 } elseif ($item['verb'] == Activity::ATTENDNO) {
1131 } elseif ($item['verb'] == Activity::ATTENDMAYBE) {
1132 $type = 'TentativeAccept';
1133 } elseif ($item['verb'] == Activity::FOLLOW) {
1135 } elseif ($item['verb'] == Activity::TAG) {
1137 } elseif ($item['verb'] == Activity::ANNOUNCE) {
1147 * Creates the activity or fetches it from the cache
1149 * @param integer $item_id Item id
1150 * @param boolean $force Force new cache entry
1151 * @return array|false activity or false on failure
1152 * @throws \Exception
1154 public static function createCachedActivityFromItem(int $item_id, bool $force = false, bool $object_mode = false)
1156 $cachekey = 'APDelivery:createActivity:' . $item_id . ':' . (int)$object_mode;
1159 $data = DI::cache()->get($cachekey);
1160 if (!is_null($data)) {
1165 $data = self::createActivityFromItem($item_id, $object_mode);
1167 DI::cache()->set($cachekey, $data, Duration::QUARTER_HOUR);
1172 * Creates an activity array for a given item id
1174 * @param integer $item_id
1175 * @param boolean $object_mode Is the activity item is used inside another object?
1176 * @param boolean $api_mode "true" if used for the API
1177 * @return false|array
1178 * @throws \Exception
1180 public static function createActivityFromItem(int $item_id, bool $object_mode = false, $api_mode = false)
1182 $condition = ['id' => $item_id];
1184 $condition['parent-network'] = Protocol::NATIVE_SUPPORT;
1186 Logger::info('Fetching activity', $condition);
1187 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, $condition);
1188 if (!DBA::isResult($item)) {
1191 return self::createActivityFromArray($item, $object_mode, $api_mode);
1195 * Creates an activity array for a given URI-Id and uid
1197 * @param integer $uri_id
1198 * @param integer $uid
1199 * @param boolean $object_mode Is the activity item is used inside another object?
1200 * @param boolean $api_mode "true" if used for the API
1201 * @return false|array
1202 * @throws \Exception
1204 public static function createActivityFromUriId(int $uri_id, int $uid, bool $object_mode = false, $api_mode = false)
1206 $condition = ['uri-id' => $uri_id, 'uid' => [0, $uid]];
1208 $condition['parent-network'] = Protocol::NATIVE_SUPPORT;
1210 Logger::info('Fetching activity', $condition);
1211 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, $condition, ['order' => ['uid' => true]]);
1212 if (!DBA::isResult($item)) {
1216 return self::createActivityFromArray($item, $object_mode, $api_mode);
1220 * Creates an activity array for a given item id
1222 * @param integer $item_id
1223 * @param boolean $object_mode Is the activity item is used inside another object?
1224 * @param boolean $api_mode "true" if used for the API
1225 * @return false|array
1226 * @throws \Exception
1228 private static function createActivityFromArray(array $item, bool $object_mode = false, $api_mode = false)
1230 if (!$api_mode && !$item['deleted'] && $item['network'] == Protocol::ACTIVITYPUB) {
1231 $data = Post\Activity::getByURIId($item['uri-id']);
1232 if (!$item['origin'] && !empty($data)) {
1233 if (!$object_mode) {
1234 Logger::info('Return stored conversation', ['item' => $item['id']]);
1236 } elseif (!empty($data['object'])) {
1237 Logger::info('Return stored conversation object', ['item' => $item['id']]);
1238 return $data['object'];
1243 if (!$api_mode && !$item['origin']) {
1244 Logger::debug('Post is not ours and is not stored', ['id' => $item['id'], 'uri-id' => $item['uri-id']]);
1248 $type = self::getTypeOfItem($item);
1250 if (!$object_mode) {
1251 $data = ['@context' => $context ?? ActivityPub::CONTEXT];
1253 if ($item['deleted'] && ($item['gravity'] == Item::GRAVITY_ACTIVITY)) {
1255 } elseif ($item['deleted']) {
1262 if ($type == 'Delete') {
1263 $data['id'] = Item::newURI($item['guid']) . '/' . $type;;
1264 } elseif (($item['gravity'] == Item::GRAVITY_ACTIVITY) && ($type != 'Undo')) {
1265 $data['id'] = $item['uri'];
1267 $data['id'] = $item['uri'] . '/' . $type;
1270 $data['type'] = $type;
1272 if (($type != 'Announce') || ($item['gravity'] != Item::GRAVITY_PARENT)) {
1273 $link = $item['author-link'];
1274 $id = $item['author-id'];
1276 $link = $item['owner-link'];
1277 $id = $item['owner-id'];
1281 $data['actor'] = self::getActorArrayByCid($id);
1283 $data['actor'] = $link;
1286 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
1288 $data['instrument'] = self::getService();
1290 $data = array_merge($data, self::createPermissionBlockForItem($item, false));
1292 if (in_array($data['type'], ['Create', 'Update', 'Delete'])) {
1293 $data['object'] = self::createNote($item, $api_mode);
1294 } elseif ($data['type'] == 'Add') {
1295 $data = self::createAddTag($item, $data);
1296 } elseif ($data['type'] == 'Announce') {
1297 if ($item['verb'] == ACTIVITY::ANNOUNCE) {
1298 $data['object'] = $item['thr-parent'];
1300 $data = self::createAnnounce($item, $data, $api_mode);
1302 } elseif ($data['type'] == 'Follow') {
1303 $data['object'] = $item['parent-uri'];
1304 } elseif ($data['type'] == 'Undo') {
1305 $data['object'] = self::createActivityFromItem($item['id'], true);
1307 $data['diaspora:guid'] = $item['guid'];
1308 if (!empty($item['signed_text'])) {
1309 $data['diaspora:like'] = $item['signed_text'];
1311 $data['object'] = $item['thr-parent'];
1314 if (!empty($item['contact-uid'])) {
1315 $uid = $item['contact-uid'];
1317 $uid = $item['uid'];
1320 Logger::info('Fetched activity', ['item' => $item['id'], 'uid' => $uid]);
1322 // We only sign our own activities
1323 if (!$api_mode && !$object_mode && $item['origin']) {
1324 $owner = User::getOwnerDataById($uid);
1325 return LDSignature::sign($data, $owner);
1330 /// @todo Create "conversation" entry
1334 * Creates a location entry for a given item array
1336 * @param array $item Item array
1337 * @return array with location array
1339 private static function createLocation(array $item): array
1341 $location = ['type' => 'Place'];
1343 if (!empty($item['location'])) {
1344 $location['name'] = $item['location'];
1349 if (empty($item['coord'])) {
1350 $coord = Map::getCoordinates($item['location']);
1352 $coords = explode(' ', $item['coord']);
1353 if (count($coords) == 2) {
1354 $coord = ['lat' => $coords[0], 'lon' => $coords[1]];
1358 if (!empty($coord['lat']) && !empty($coord['lon'])) {
1359 $location['latitude'] = $coord['lat'];
1360 $location['longitude'] = $coord['lon'];
1367 * Returns a tag array for a given item array
1369 * @param array $item Item array
1370 * @param string $quote_url Url of the attached quote link
1371 * @return array of tags
1372 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1374 private static function createTagList(array $item, string $quote_url): array
1378 $terms = Tag::getByURIId($item['uri-id'], [Tag::HASHTAG, Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1379 foreach ($terms as $term) {
1380 if ($term['type'] == Tag::HASHTAG) {
1381 $url = DI::baseUrl() . '/search?tag=' . urlencode($term['name']);
1382 $tags[] = ['type' => 'Hashtag', 'href' => $url, 'name' => '#' . $term['name']];
1384 $contact = Contact::getByURL($term['url'], false, ['addr']);
1385 if (empty($contact)) {
1388 if (!empty($contact['addr'])) {
1389 $mention = '@' . $contact['addr'];
1391 $mention = '@' . $term['url'];
1394 $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
1398 $announce = self::getAnnounceArray($item);
1399 // Mention the original author upon commented reshares
1400 if (!empty($announce['comment'])) {
1401 $tags[] = ['type' => 'Mention', 'href' => $announce['actor']['url'], 'name' => '@' . $announce['actor']['addr']];
1404 // @see https://codeberg.org/fediverse/fep/src/branch/main/feps/fep-e232.md
1405 if (!empty($quote_url)) {
1406 // Currently deactivated because of compatibility issues with Pleroma
1408 // 'type' => 'Link',
1409 // 'mediaType' => 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"',
1410 // 'href' => $quote_url,
1411 // 'name' => '♲ ' . BBCode::convertForUriId($item['uri-id'], $quote_url, BBCode::ACTIVITYPUB)
1419 * Adds attachment data to the JSON document
1421 * @param array $item Data of the item that is to be posted
1423 * @return array with attachment data
1424 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1426 private static function createAttachmentList(array $item): array
1431 foreach (Post\Media::getByURIId($item['uri-id'], [Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO, Post\Media::DOCUMENT, Post\Media::TORRENT]) as $attachment) {
1432 if (in_array($attachment['url'], $urls)) {
1435 $urls[] = $attachment['url'];
1437 $attach = ['type' => 'Document',
1438 'mediaType' => $attachment['mimetype'],
1439 'url' => $attachment['url'],
1440 'name' => $attachment['description']];
1442 if (!empty($attachment['height'])) {
1443 $attach['height'] = $attachment['height'];
1446 if (!empty($attachment['width'])) {
1447 $attach['width'] = $attachment['width'];
1450 if (!empty($attachment['preview'])) {
1451 $attach['image'] = $attachment['preview'];
1454 $attachments[] = $attach;
1457 return $attachments;
1461 * Callback function to replace a Friendica style mention in a mention for a summary
1463 * @param array $match Matching values for the callback
1464 * @return string Replaced mention
1465 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1467 private static function mentionAddrCallback(array $match): string
1469 if (empty($match[1])) {
1473 $data = Contact::getByURL($match[1], false, ['addr']);
1474 if (empty($data['addr'])) {
1478 return '@' . $data['addr'];
1482 * Remove image elements since they are added as attachment
1484 * @param string $body HTML code
1485 * @return string with removed images
1487 private static function removePictures(string $body): string
1489 return BBCode::performWithEscapedTags($body, ['code', 'noparse', 'nobb', 'pre'], function ($text) {
1490 // Simplify image codes
1491 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
1492 $text = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $text);
1494 // Now remove local links
1495 $text = preg_replace_callback(
1496 '/\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]/Usi',
1498 // We remove the link when it is a link to a local photo page
1499 if (Photo::isLocalPage($match[1])) {
1502 // otherwise we just return the link
1503 return '[url]' . $match[1] . '[/url]';
1508 // Remove all pictures
1509 return preg_replace("/\[img\]([^\[\]]*)\[\/img\]/Usi", '', $text);
1514 * Returns if the post contains sensitive content ("nsfw")
1516 * @param integer $uri_id URI id
1517 * @return boolean Whether URI id was found
1518 * @throws \Exception
1520 private static function isSensitive(int $uri_id): bool
1522 return DBA::exists('tag-view', ['uri-id' => $uri_id, 'name' => 'nsfw', 'type' => Tag::HASHTAG]);
1526 * Creates event data
1528 * @param array $item Item array
1529 * @return array with the event data
1530 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1532 private static function createEvent(array $item): array
1535 $event['name'] = $item['event-summary'];
1536 $event['content'] = BBCode::convertForUriId($item['uri-id'], $item['event-desc'], BBCode::ACTIVITYPUB);
1537 $event['startTime'] = DateTimeFormat::utc($item['event-start'], 'c');
1539 if (!$item['event-nofinish']) {
1540 $event['endTime'] = DateTimeFormat::utc($item['event-finish'], 'c');
1543 if (!empty($item['event-location'])) {
1544 $item['location'] = $item['event-location'];
1545 $event['location'] = self::createLocation($item);
1548 // 2021.12: Backward compatibility value, all the events now "adjust" to the viewer timezone
1549 $event['dfrn:adjust'] = true;
1555 * Creates a note/article object array
1557 * @param array $item
1558 * @param bool $api_mode
1559 * @return array with the object data
1560 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1561 * @throws \ImagickException
1563 public static function createNote(array $item, bool $api_mode = false): array
1569 // We are treating posts differently when they are directed to a community.
1570 // This is done to better support Lemmy. Most of the changes should work with other systems as well.
1571 // But to not risk compatibility issues we currently perform the changes only for communities.
1572 if ($item['gravity'] == Item::GRAVITY_PARENT) {
1573 $isCommunityPost = !empty(Tag::getByURIId($item['uri-id'], [Tag::EXCLUSIVE_MENTION]));
1574 $links = Post\Media::getByURIId($item['uri-id'], [Post\Media::HTML]);
1575 if ($isCommunityPost && (count($links) == 1)) {
1576 $link = $links[0]['url'];
1579 $isCommunityPost = false;
1582 if ($item['event-type'] == 'event') {
1584 } elseif (!empty($item['title'])) {
1585 if (!$isCommunityPost || empty($link)) {
1588 // "Page" is used by Lemmy for posts that contain an external link
1595 if ($item['deleted']) {
1596 $type = 'Tombstone';
1600 $data['id'] = $item['uri'];
1601 $data['type'] = $type;
1603 if ($item['deleted']) {
1607 $data['summary'] = BBCode::toPlaintext(BBCode::getAbstract($item['body'], Protocol::ACTIVITYPUB));
1609 if ($item['uri'] != $item['thr-parent']) {
1610 $data['inReplyTo'] = $item['thr-parent'];
1612 $data['inReplyTo'] = null;
1615 $data['diaspora:guid'] = $item['guid'];
1616 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
1618 if ($item['created'] != $item['edited']) {
1619 $data['updated'] = DateTimeFormat::utc($item['edited'] . '+00:00', DateTimeFormat::ATOM);
1622 $data['url'] = $link ?? $item['plink'];
1624 $data['attributedTo'] = self::getActorArrayByCid($item['author-id']);
1626 $data['attributedTo'] = $item['author-link'];
1628 $data['sensitive'] = self::isSensitive($item['uri-id']);
1630 if (!empty($item['conversation']) && ($item['conversation'] != './')) {
1631 $data['conversation'] = $data['context'] = $item['conversation'];
1634 if (!empty($item['title'])) {
1635 $data['name'] = BBCode::toPlaintext($item['title'], false);
1638 $permission_block = self::createPermissionBlockForItem($item, false);
1640 $real_quote = false;
1642 $body = $item['body'];
1644 if ($type == 'Note') {
1645 $body = $item['raw-body'] ?? self::removePictures($body);
1649 * @todo Improve the automated summary
1650 * This part is currently deactivated. The automated summary seems to be more
1651 * confusing than helping. But possibly we will find a better way.
1652 * So the code is left here for now as a reminder
1654 * } elseif (($type == 'Article') && empty($data['summary'])) {
1655 * $regexp = "/[@!]\[url\=([^\[\]]*)\].*?\[\/url\]/ism";
1656 * $summary = preg_replace_callback($regexp, [self::class, 'mentionAddrCallback'], $body);
1657 * $data['summary'] = BBCode::toPlaintext(Plaintext::shorten(self::removePictures($summary), 1000));
1661 if (empty($item['uid']) || !Feature::isEnabled($item['uid'], 'explicit_mentions')) {
1662 $body = self::prependMentions($body, $item['uri-id'], $item['author-link']);
1665 if ($type == 'Event') {
1666 $data = array_merge($data, self::createEvent($item));
1668 if ($isCommunityPost) {
1669 // For community posts we remove the visible "!user@domain.tld".
1670 // This improves the look at systems like Lemmy.
1671 // Also in the future we should control the community delivery via other methods.
1672 $body = preg_replace("/!\[url\=[^\[\]]*\][^\[\]]*\[\/url\]/ism", '', $body);
1675 if ($type == 'Page') {
1676 // When we transmit "Page" posts we have to remove the attachment.
1677 // The attachment contains the link that we already transmit in the "url" field.
1678 $body = preg_replace("/\s*\[attachment .*?\].*?\[\/attachment\]\s*/ism", '', $body);
1681 $body = BBCode::setMentionsToNicknames($body);
1683 if (!empty($item['quote-uri-id'])) {
1684 if (Post::exists(['uri-id' => $item['quote-uri-id'], 'network' => [Protocol::ACTIVITYPUB, Protocol::DFRN]])) {
1686 $data['quoteUrl'] = $item['quote-uri'];
1687 $body = DI::contentItem()->addShareLink($body, $item['quote-uri-id']);
1689 $body = DI::contentItem()->addSharedPost($item, $body);
1693 $data['content'] = BBCode::convertForUriId($item['uri-id'], $body, BBCode::ACTIVITYPUB);
1696 // The regular "content" field does contain a minimized HTML. This is done since systems like
1697 // Mastodon has got problems with - for example - embedded pictures.
1698 // The contentMap does contain the unmodified HTML.
1699 $language = self::getLanguage($item);
1700 if (!empty($language)) {
1701 $richbody = BBCode::setMentionsToNicknames($item['body'] ?? '');
1702 $richbody = Post\Media::removeFromEndOfBody($richbody);
1703 if (!empty($item['quote-uri-id'])) {
1705 $richbody = DI::contentItem()->addShareLink($richbody, $item['quote-uri-id']);
1707 $richbody = DI::contentItem()->addSharedPost($item, $richbody);
1710 $richbody = BBCode::removeAttachment($richbody);
1712 $data['contentMap'][$language] = BBCode::convertForUriId($item['uri-id'], $richbody, BBCode::EXTERNAL);
1715 if (!empty($item['quote-uri-id'])) {
1716 $source = DI::contentItem()->addSharedPost($item, $item['body']);
1718 $source = $item['body'];
1721 $data['source'] = ['content' => $source, 'mediaType' => "text/bbcode"];
1723 if (!empty($item['signed_text']) && ($item['uri'] != $item['thr-parent'])) {
1724 $data['diaspora:comment'] = $item['signed_text'];
1727 $data['attachment'] = self::createAttachmentList($item);
1728 $data['tag'] = self::createTagList($item, $data['quoteUrl'] ?? '');
1730 if (empty($data['location']) && (!empty($item['coord']) || !empty($item['location']))) {
1731 $data['location'] = self::createLocation($item);
1734 if (!empty($item['app'])) {
1735 $data['generator'] = ['type' => 'Application', 'name' => $item['app']];
1738 $data = array_merge($data, $permission_block);
1744 * Fetches the language from the post, the user or the system.
1746 * @param array $item
1747 * @return string language string
1749 private static function getLanguage(array $item): string
1751 // Try to fetch the language from the post itself
1752 if (!empty($item['language'])) {
1753 $languages = array_keys(json_decode($item['language'], true));
1754 if (!empty($languages[0])) {
1755 return $languages[0];
1759 // Otherwise use the user's language
1760 if (!empty($item['uid'])) {
1761 $user = DBA::selectFirst('user', ['language'], ['uid' => $item['uid']]);
1762 if (!empty($user['language'])) {
1763 return $user['language'];
1767 // And finally just use the system language
1768 return DI::config()->get('system', 'language');
1772 * Creates an an "add tag" entry
1774 * @param array $item Item array
1775 * @param array $activity activity data
1776 * @return array with activity data for adding tags
1777 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1778 * @throws \ImagickException
1780 private static function createAddTag(array $item, array $activity): array
1782 $object = XML::parseString($item['object']);
1783 $target = XML::parseString($item['target']);
1785 $activity['diaspora:guid'] = $item['guid'];
1786 $activity['actor'] = $item['author-link'];
1787 $activity['target'] = (string)$target->id;
1788 $activity['summary'] = BBCode::toPlaintext($item['body']);
1789 $activity['object'] = ['id' => (string)$object->id, 'type' => 'tag', 'name' => (string)$object->title, 'content' => (string)$object->content];
1795 * Creates an announce object entry
1797 * @param array $item Item array
1798 * @param array $activity activity data
1799 * @param bool $api_mode
1800 * @return array with activity data
1801 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1802 * @throws \ImagickException
1804 private static function createAnnounce(array $item, array $activity, bool $api_mode = false): array
1806 $orig_body = $item['body'];
1807 $announce = self::getAnnounceArray($item);
1808 if (empty($announce)) {
1809 $activity['type'] = 'Create';
1810 $activity['object'] = self::createNote($item, $api_mode);
1814 if (empty($announce['comment'])) {
1815 // Pure announce, without a quote
1816 $activity['type'] = 'Announce';
1817 $activity['object'] = $announce['object']['uri'];
1822 $activity['type'] = 'Create';
1823 $item['body'] = $announce['comment'] . "\n" . $announce['object']['plink'];
1824 $activity['object'] = self::createNote($item, $api_mode);
1826 /// @todo Finally descide how to implement this in AP. This is a possible way:
1827 $activity['object']['attachment'][] = self::createNote($announce['object']);
1829 $activity['object']['source']['content'] = $orig_body;
1834 * Return announce related data if the item is an annunce
1836 * @param array $item
1837 * @return array Announcement array
1839 private static function getAnnounceArray(array $item): array
1841 $reshared = DI::contentItem()->getSharedPost($item, Item::DELIVER_FIELDLIST);
1842 if (empty($reshared)) {
1846 if (!in_array($reshared['post']['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
1850 $profile = APContact::getByURL($reshared['post']['author-link'], false);
1851 if (empty($profile)) {
1855 return ['object' => $reshared['post'], 'actor' => $profile, 'comment' => $reshared['comment']];
1859 * Checks if the provided item array is an announce
1861 * @param array $item Item array
1862 * @return boolean Whether item is an announcement
1864 public static function isAnnounce(array $item): bool
1866 if (!empty($item['verb']) && ($item['verb'] == Activity::ANNOUNCE)) {
1870 $announce = self::getAnnounceArray($item);
1871 if (empty($announce)) {
1875 return empty($announce['comment']);
1879 * Creates an activity id for a given contact id
1881 * @param integer $cid Contact ID of target
1883 * @return bool|string activity id
1885 public static function activityIDFromContact(int $cid)
1887 $contact = DBA::selectFirst('contact', ['uid', 'id', 'created'], ['id' => $cid]);
1888 if (!DBA::isResult($contact)) {
1892 $hash = hash('ripemd128', $contact['uid'].'-'.$contact['id'].'-'.$contact['created']);
1893 $uuid = substr($hash, 0, 8). '-' . substr($hash, 8, 4) . '-' . substr($hash, 12, 4) . '-' . substr($hash, 16, 4) . '-' . substr($hash, 20, 12);
1894 return DI::baseUrl() . '/activity/' . $uuid;
1898 * Transmits a contact suggestion to a given inbox
1900 * @param array $owner Sender owner-view record
1901 * @param string $inbox Target inbox
1902 * @param integer $suggestion_id Suggestion ID
1903 * @return boolean was the transmission successful?
1904 * @throws \Exception
1906 public static function sendContactSuggestion(array $owner, string $inbox, int $suggestion_id): bool
1908 $suggestion = DI::fsuggest()->selectOneById($suggestion_id);
1911 '@context' => ActivityPub::CONTEXT,
1912 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1913 'type' => 'Announce',
1914 'actor' => $owner['url'],
1915 'object' => $suggestion->url,
1916 'content' => $suggestion->note,
1917 'instrument' => self::getService(),
1918 'to' => [ActivityPub::PUBLIC_COLLECTION],
1922 $signed = LDSignature::sign($data, $owner);
1924 Logger::info('Deliver profile deletion for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
1925 return HTTPSignature::transmit($signed, $inbox, $owner);
1929 * Transmits a profile relocation to a given inbox
1931 * @param array $owner Sender owner-view record
1932 * @param string $inbox Target inbox
1933 * @return boolean was the transmission successful?
1934 * @throws \Exception
1936 public static function sendProfileRelocation(array $owner, string $inbox): bool
1939 '@context' => ActivityPub::CONTEXT,
1940 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1941 'type' => 'dfrn:relocate',
1942 'actor' => $owner['url'],
1943 'object' => $owner['url'],
1944 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1945 'instrument' => self::getService(),
1946 'to' => [ActivityPub::PUBLIC_COLLECTION],
1950 $signed = LDSignature::sign($data, $owner);
1952 Logger::info('Deliver profile relocation for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
1953 return HTTPSignature::transmit($signed, $inbox, $owner);
1957 * Transmits a profile deletion to a given inbox
1959 * @param array $owner Sender owner-view record
1960 * @param string $inbox Target inbox
1961 * @return boolean was the transmission successful?
1962 * @throws \Exception
1964 public static function sendProfileDeletion(array $owner, string $inbox): bool
1966 if (empty($owner['uprvkey'])) {
1967 Logger::error('No private key for owner found, the deletion message cannot be processed.', ['user' => $owner['uid']]);
1971 $data = ['@context' => ActivityPub::CONTEXT,
1972 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1974 'actor' => $owner['url'],
1975 'object' => $owner['url'],
1976 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1977 'instrument' => self::getService(),
1978 'to' => [ActivityPub::PUBLIC_COLLECTION],
1981 $signed = LDSignature::sign($data, $owner);
1983 Logger::info('Deliver profile deletion for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
1984 return HTTPSignature::transmit($signed, $inbox, $owner);
1988 * Transmits a profile change to a given inbox
1990 * @param array $owner Sender owner-view record
1991 * @param string $inbox Target inbox
1992 * @return boolean was the transmission successful?
1993 * @throws HTTPException\InternalServerErrorException
1994 * @throws HTTPException\NotFoundException
1995 * @throws \ImagickException
1997 public static function sendProfileUpdate(array $owner, string $inbox): bool
1999 $profile = APContact::getByURL($owner['url']);
2001 $data = ['@context' => ActivityPub::CONTEXT,
2002 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2004 'actor' => $owner['url'],
2005 'object' => self::getProfile($owner['uid']),
2006 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
2007 'instrument' => self::getService(),
2008 'to' => [$profile['followers']],
2011 $signed = LDSignature::sign($data, $owner);
2013 Logger::info('Deliver profile update for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
2014 return HTTPSignature::transmit($signed, $inbox, $owner);
2018 * Transmits a given activity to a target
2020 * @param string $activity Type name
2021 * @param string $target Target profile
2022 * @param integer $uid User ID
2023 * @param string $id Activity-identifier
2025 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2026 * @throws \ImagickException
2027 * @throws \Exception
2029 public static function sendActivity(string $activity, string $target, int $uid, string $id = ''): bool
2031 $profile = APContact::getByURL($target);
2032 if (empty($profile['inbox'])) {
2033 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2037 $owner = User::getOwnerDataById($uid);
2038 if (empty($owner)) {
2039 Logger::warning('No user found for actor, aborting', ['uid' => $uid]);
2044 $id = DI::baseUrl() . '/activity/' . System::createGUID();
2048 '@context' => ActivityPub::CONTEXT,
2050 'type' => $activity,
2051 'actor' => $owner['url'],
2052 'object' => $profile['url'],
2053 'instrument' => self::getService(),
2054 'to' => [$profile['url']],
2057 Logger::info('Sending activity ' . $activity . ' to ' . $target . ' for user ' . $uid);
2059 $signed = LDSignature::sign($data, $owner);
2060 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2064 * Transmits a "follow object" activity to a target
2065 * This is a preparation for sending automated "follow" requests when receiving "Announce" messages
2067 * @param string $object Object URL
2068 * @param string $target Target profile
2069 * @param integer $uid User ID
2071 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2072 * @throws \ImagickException
2073 * @throws \Exception
2075 public static function sendFollowObject(string $object, string $target, int $uid = 0): bool
2077 $profile = APContact::getByURL($target);
2078 if (empty($profile['inbox'])) {
2079 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2084 // We need to use some user as a sender. It doesn't care who it will send. We will use an administrator account.
2085 $admin = User::getFirstAdmin(['uid']);
2087 Logger::warning('No available admin user for transmission', ['target' => $target]);
2091 $uid = $admin['uid'];
2094 $condition = ['verb' => Activity::FOLLOW, 'uid' => 0, 'parent-uri' => $object,
2095 'author-id' => Contact::getPublicIdByUserId($uid)];
2096 if (Post::exists($condition)) {
2097 Logger::info('Follow for ' . $object . ' for user ' . $uid . ' does already exist.');
2101 $owner = User::getOwnerDataById($uid);
2104 '@context' => ActivityPub::CONTEXT,
2105 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2107 'actor' => $owner['url'],
2108 'object' => $object,
2109 'instrument' => self::getService(),
2110 'to' => [$profile['url']],
2113 Logger::info('Sending follow ' . $object . ' to ' . $target . ' for user ' . $uid);
2115 $signed = LDSignature::sign($data, $owner);
2116 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2120 * Transmit a message that the contact request had been accepted
2122 * @param string $target Target profile
2123 * @param string $id Object id
2124 * @param integer $uid User ID
2126 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2127 * @throws \ImagickException
2129 public static function sendContactAccept(string $target, string $id, int $uid)
2131 $profile = APContact::getByURL($target);
2132 if (empty($profile['inbox'])) {
2133 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2137 $owner = User::getOwnerDataById($uid);
2139 Logger::notice('No user found for actor', ['uid' => $uid]);
2144 '@context' => ActivityPub::CONTEXT,
2145 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2147 'actor' => $owner['url'],
2151 'actor' => $profile['url'],
2152 'object' => $owner['url']
2154 'instrument' => self::getService(),
2155 'to' => [$profile['url']],
2158 Logger::debug('Sending accept to ' . $target . ' for user ' . $uid . ' with id ' . $id);
2160 $signed = LDSignature::sign($data, $owner);
2161 HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2165 * Reject a contact request or terminates the contact relation
2167 * @param string $target Target profile
2168 * @param string $objectId Object id
2169 * @param array $owner Sender owner-view record
2170 * @return bool Operation success
2171 * @throws HTTPException\InternalServerErrorException
2172 * @throws \ImagickException
2174 public static function sendContactReject(string $target, string $objectId, array $owner): bool
2176 $profile = APContact::getByURL($target);
2177 if (empty($profile['inbox'])) {
2178 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2183 '@context' => ActivityPub::CONTEXT,
2184 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2186 'actor' => $owner['url'],
2190 'actor' => $profile['url'],
2191 'object' => $owner['url']
2193 'instrument' => self::getService(),
2194 'to' => [$profile['url']],
2197 Logger::debug('Sending reject to ' . $target . ' for user ' . $owner['uid'] . ' with id ' . $objectId);
2199 $signed = LDSignature::sign($data, $owner);
2200 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2204 * Transmits a message that we don't want to follow this contact anymore
2206 * @param string $target Target profile
2207 * @param integer $cid Contact id
2208 * @param array $owner Sender owner-view record
2209 * @return bool success
2210 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2211 * @throws \ImagickException
2212 * @throws \Exception
2214 public static function sendContactUndo(string $target, int $cid, array $owner): bool
2216 $profile = APContact::getByURL($target);
2217 if (empty($profile['inbox'])) {
2218 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2222 $object_id = self::activityIDFromContact($cid);
2223 if (empty($object_id)) {
2227 $objectId = DI::baseUrl() . '/activity/' . System::createGUID();
2230 '@context' => ActivityPub::CONTEXT,
2233 'actor' => $owner['url'],
2237 'actor' => $owner['url'],
2238 'object' => $profile['url']
2240 'instrument' => self::getService(),
2241 'to' => [$profile['url']],
2244 Logger::info('Sending undo to ' . $target . ' for user ' . $owner['uid'] . ' with id ' . $objectId);
2246 $signed = LDSignature::sign($data, $owner);
2247 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2251 * Prepends mentions (@) to $body variable
2253 * @param string $body HTML code
2255 * @param string $authorLink Author link
2256 * @return string HTML code with prepended mentions
2258 private static function prependMentions(string $body, int $uriid, string $authorLink): string
2262 foreach (Tag::getByURIId($uriid, [Tag::IMPLICIT_MENTION]) as $tag) {
2263 $profile = Contact::getByURL($tag['url'], false, ['addr', 'contact-type', 'nick']);
2264 if (!empty($profile['addr'])
2265 && $profile['contact-type'] != Contact::TYPE_COMMUNITY
2266 && !strstr($body, $profile['addr'])
2267 && !strstr($body, $tag['url'])
2268 && $tag['url'] !== $authorLink
2270 $mentions[] = '@[url=' . $tag['url'] . ']' . $profile['nick'] . '[/url]';
2274 $mentions[] = $body;
2276 return implode(' ', $mentions);