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' => (string)DI::baseUrl()
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 actor 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
496 * @return array with permissions
497 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
498 * @throws \ImagickException
500 private static function fetchPermissionBlockFromThreadParent(array $item, bool $is_group_thread): array
502 if (empty($item['thr-parent-id'])) {
506 $parent = Post::selectFirstPost(['author-link'], ['uri-id' => $item['thr-parent-id']]);
507 if (empty($parent)) {
512 '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', Tag::AUDIENCE => 'audience'];
529 foreach (Tag::getByURIId($item['thr-parent-id'], [Tag::TO, Tag::CC, Tag::BTO, Tag::BCC, Tag::AUDIENCE]) as $receiver) {
530 if (!empty($parent_profile['followers']) && $receiver['url'] == $parent_profile['followers'] && !empty($item_profile['followers'])) {
531 if (!$is_group_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 boolean $expand_followers Expand the list of followers
563 * @param integer $last_id Last item id for adding receivers
565 * @return array with permission data
566 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
567 * @throws \ImagickException
569 private static function createPermissionBlockForItem(array $item, bool $blindcopy, bool $expand_followers, int $last_id = 0): array
572 $last_id = $item['id'];
582 // Check if we should always deliver our stuff via BCC
583 if (!empty($item['uid'])) {
584 $owner = User::getOwnerDataById($item['uid']);
585 if (!empty($owner)) {
586 $always_bcc = $owner['hide-friends'];
587 $is_group = ($owner['account-type'] == User::ACCOUNT_TYPE_COMMUNITY);
589 $profile = APContact::getByURL($owner['url'], false);
590 $follower = $profile['followers'] ?? '';
594 if (DI::config()->get('system', 'ap_always_bcc')) {
598 $parent = Post::selectFirst(['causer-link', 'post-reason'], ['id' => $item['parent']]);
599 if (!empty($parent) && ($parent['post-reason'] == Item::PR_ANNOUNCEMENT) && !empty($parent['causer-link'])) {
600 $profile = APContact::getByURL($parent['causer-link'], false);
601 $is_group_thread = isset($profile['type']) && $profile['type'] == 'Group';
603 $is_group_thread = false;
607 $parent_tags = Tag::getByURIId($item['parent-uri-id'], [Tag::AUDIENCE, Tag::MENTION]);
608 if (!empty($parent_tags)) {
609 $is_group_thread = false;
610 foreach ($parent_tags as $tag) {
611 if ($tag['type'] != Tag::AUDIENCE) {
614 $profile = APContact::getByURL($tag['url'], false);
615 if (!empty($profile) && ($profile['type'] == 'Group')) {
616 $audience[] = $tag['url'];
617 $is_group_thread = true;
620 if ($is_group_thread) {
621 foreach ($parent_tags as $tag) {
622 if (($tag['type'] == Tag::MENTION) && in_array($tag['url'], $audience)) {
626 $exclusive = !$mention;
628 } elseif ($is_group_thread) {
629 foreach (Tag::getByURIId($item['parent-uri-id'], [Tag::MENTION, Tag::EXCLUSIVE_MENTION]) as $term) {
630 $profile = APContact::getByURL($term['url'], false);
631 if (!empty($profile) && ($profile['type'] == 'Group')) {
632 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
633 $audience[] = $term['url'];
635 } elseif ($term['type'] == Tag::MENTION) {
642 $audience[] = $owner['url'];
645 if (self::isAnnounce($item) || self::isAPPost($last_id)) {
646 // Will be activated in a later step
647 $networks = Protocol::FEDERATED;
649 // For now only send to these contacts:
650 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
653 $data = ['to' => [], 'cc' => [], 'bcc' => [] , 'audience' => $audience];
655 if ($item['gravity'] == Item::GRAVITY_PARENT) {
656 $actor_profile = APContact::getByURL($item['owner-link']);
658 $actor_profile = APContact::getByURL($item['author-link']);
661 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION, Tag::AUDIENCE]);
663 if ($item['private'] != Item::PRIVATE) {
664 // Directly mention the original author upon a quoted reshare.
665 // Else just ensure that the original author receives the reshare.
666 $announce = self::getAnnounceArray($item);
667 if (!empty($announce['comment'])) {
668 $data['to'][] = $announce['actor']['url'];
669 } elseif (!empty($announce)) {
670 $data['cc'][] = $announce['actor']['url'];
674 $data = array_merge_recursive($data, self::fetchPermissionBlockFromThreadParent($item, $is_group_thread));
677 // Check if the item is completely public or unlisted
678 if ($item['private'] == Item::PUBLIC) {
679 $data['to'][] = ActivityPub::PUBLIC_COLLECTION;
681 $data['cc'][] = ActivityPub::PUBLIC_COLLECTION;
684 foreach ($terms as $term) {
685 $profile = APContact::getByURL($term['url'], false);
686 if (!empty($profile)) {
687 if (($term['type'] == Tag::AUDIENCE) && ($profile['type'] == 'Group')) {
688 $data['audience'][] = $profile['url'];
690 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
692 if (!empty($profile['followers']) && ($profile['type'] == 'Group')) {
693 $data['cc'][] = $profile['followers'];
694 $data['audience'][] = $profile['url'];
696 } elseif (($term['type'] == Tag::MENTION) && ($profile['type'] == 'Group')) {
699 $data['to'][] = $profile['url'];
702 if (!$exclusive && ($item['private'] == Item::UNLISTED)) {
703 $data['to'][] = $actor_profile['followers'];
706 $receiver_list = Item::enumeratePermissions($item, true, $expand_followers);
708 foreach ($terms as $term) {
709 $cid = Contact::getIdForURL($term['url'], $item['uid']);
710 if (!empty($cid) && in_array($cid, $receiver_list)) {
711 $contact = DBA::selectFirst('contact', ['url', 'network', 'protocol', 'gsid'], ['id' => $cid, 'network' => Protocol::FEDERATED]);
712 if (!DBA::isResult($contact) || !self::isAPContact($contact, $networks)) {
716 $profile = APContact::getByURL($term['url'], false);
717 if (!empty($profile)) {
718 if (($term['type'] == Tag::AUDIENCE) && ($profile['type'] == 'Group')) {
719 $data['audience'][] = $profile['url'];
721 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
723 if (!empty($profile['followers']) && ($profile['type'] == 'Group')) {
724 $data['cc'][] = $profile['followers'];
725 $data['audience'][] = $profile['url'];
727 } elseif (($term['type'] == Tag::MENTION) && ($profile['type'] == 'Group')) {
730 $data['to'][] = $profile['url'];
739 if ($is_group && !$exclusive && !empty($follower)) {
740 $data['cc'][] = $follower;
741 } elseif (!$exclusive) {
742 foreach ($receiver_list as $receiver) {
743 if ($receiver == -1) {
744 $data['to'][] = $actor_profile['followers'];
748 $contact = DBA::selectFirst('contact', ['url', 'hidden', 'network', 'protocol', 'gsid'], ['id' => $receiver, 'network' => Protocol::FEDERATED]);
749 if (!DBA::isResult($contact) || !self::isAPContact($contact, $networks)) {
753 if (!empty($profile = APContact::getByURL($contact['url'], false))) {
754 if ($contact['hidden'] || $always_bcc) {
755 $data['bcc'][] = $profile['url'];
757 $data['cc'][] = $profile['url'];
764 if (!empty($item['parent']) && (!$exclusive || ($item['private'] == Item::PRIVATE))) {
765 if ($item['private'] == Item::PRIVATE) {
766 $condition = ['parent' => $item['parent'], 'uri-id' => $item['thr-parent-id']];
768 $condition = ['parent' => $item['parent']];
770 $parents = Post::select(['id', 'author-link', 'owner-link', 'gravity', 'uri'], $condition, ['order' => ['id']]);
771 while ($parent = Post::fetch($parents)) {
772 if ($parent['gravity'] == Item::GRAVITY_PARENT) {
773 $profile = APContact::getByURL($parent['owner-link'], false);
774 if (!empty($profile)) {
775 if ($item['gravity'] != Item::GRAVITY_PARENT) {
776 // Comments to groups are directed to the group
777 // But comments to groups aren't directed to the followers collection
778 // This rule is only valid when the actor isn't the group.
779 // The group needs to transmit their content to their followers.
780 if (($profile['type'] == 'Group') && ($profile['url'] != ($actor_profile['url'] ?? ''))) {
781 $data['to'][] = $profile['url'];
783 $data['cc'][] = $profile['url'];
784 if (($item['private'] != Item::PRIVATE) && !empty($actor_profile['followers']) && (!$exclusive || !$is_group_thread)) {
785 $data['cc'][] = $actor_profile['followers'];
788 } elseif (!$exclusive && !$is_group_thread) {
789 // Public thread parent post always are directed to the followers.
790 if ($item['private'] != Item::PRIVATE) {
791 $data['cc'][] = $actor_profile['followers'];
797 // Don't include data from future posts
798 if ($parent['id'] >= $last_id) {
802 $profile = APContact::getByURL($parent['author-link'], false);
803 if (!empty($profile)) {
804 if (($profile['type'] == 'Group') || ($parent['uri'] == $item['thr-parent'])) {
805 $data['to'][] = $profile['url'];
807 $data['cc'][] = $profile['url'];
811 DBA::close($parents);
814 $data['to'] = array_unique($data['to']);
815 $data['cc'] = array_unique($data['cc']);
816 $data['bcc'] = array_unique($data['bcc']);
817 $data['audience'] = array_unique($data['audience']);
819 if (($key = array_search($item['author-link'], $data['to'])) !== false) {
820 unset($data['to'][$key]);
823 if (($key = array_search($item['author-link'], $data['cc'])) !== false) {
824 unset($data['cc'][$key]);
827 if (($key = array_search($item['author-link'], $data['bcc'])) !== false) {
828 unset($data['bcc'][$key]);
831 foreach ($data['to'] as $to) {
832 if (($key = array_search($to, $data['cc'])) !== false) {
833 unset($data['cc'][$key]);
836 if (($key = array_search($to, $data['bcc'])) !== false) {
837 unset($data['bcc'][$key]);
841 foreach ($data['cc'] as $cc) {
842 if (($key = array_search($cc, $data['bcc'])) !== false) {
843 unset($data['bcc'][$key]);
847 $receivers = ['to' => array_values($data['to']), 'cc' => array_values($data['cc']), 'bcc' => array_values($data['bcc']), 'audience' => array_values($data['audience'])];
850 unset($receivers['bcc']);
853 foreach (['to' => Tag::TO, 'cc' => Tag::CC, 'bcc' => Tag::BCC, 'audience' => Tag::AUDIENCE] as $element => $type) {
854 if (!empty($receivers[$element])) {
855 foreach ($receivers[$element] as $receiver) {
856 if ($receiver == ActivityPub::PUBLIC_COLLECTION) {
857 $name = Receiver::PUBLIC_COLLECTION;
859 $name = trim(parse_url($receiver, PHP_URL_PATH), '/');
861 Tag::store($item['uri-id'], $type, $name, $receiver);
866 if (!$blindcopy && count($receivers['audience']) == 1) {
867 $receivers['audience'] = $receivers['audience'][0];
868 } elseif (!$receivers['audience']) {
869 unset($receivers['audience']);
876 * Check if an inbox is archived
878 * @param string $url Inbox url
879 * @return boolean "true" if inbox is archived
881 public static function archivedInbox(string $url): bool
883 return DBA::exists('inbox-status', ['url' => $url, 'archive' => true]);
887 * Check if a given contact should be delivered via AP
889 * @param array $contact Contact array
890 * @param array $networks Array with networks
891 * @return bool Whether the used protocol matches ACTIVITYPUB
894 private static function isAPContact(array $contact, array $networks): bool
896 if (in_array($contact['network'], $networks) || ($contact['protocol'] == Protocol::ACTIVITYPUB)) {
900 return GServer::getProtocol($contact['gsid'] ?? 0) == Post\DeliveryData::ACTIVITYPUB;
904 * Fetches a list of inboxes of followers of a given user
906 * @param integer $uid User ID
907 * @param boolean $personal fetch personal inboxes
908 * @param boolean $all_ap Retrieve all AP enabled inboxes
909 * @return array of follower inboxes
910 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
911 * @throws \ImagickException
913 public static function fetchTargetInboxesforUser(int $uid, bool $personal = false, bool $all_ap = false): array
918 if (!empty($item['uid'])) {
919 $profile = User::getOwnerDataById($item['uid']);
920 if (!empty($profile)) {
921 $isGroup = $profile['account-type'] == User::ACCOUNT_TYPE_COMMUNITY;
926 // Will be activated in a later step
927 $networks = Protocol::FEDERATED;
929 // For now only send to these contacts:
930 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
938 'network' => Protocol::FEDERATED,
942 $condition['rel'] = [Contact::FOLLOWER, Contact::FRIEND];
945 $contacts = DBA::select('contact', ['id', 'url', 'network', 'protocol', 'gsid'], $condition);
946 while ($contact = DBA::fetch($contacts)) {
947 if (!self::isAPContact($contact, $networks)) {
951 if ($isGroup && ($contact['network'] == Protocol::DFRN)) {
955 if (Network::isUrlBlocked($contact['url'])) {
959 $profile = APContact::getByURL($contact['url'], false);
960 if (!empty($profile)) {
961 if (empty($profile['sharedinbox']) || $personal || Contact::isLocal($contact['url'])) {
962 $target = $profile['inbox'];
964 $target = $profile['sharedinbox'];
966 if (!self::archivedInbox($target)) {
967 $inboxes[$target][] = $contact['id'];
971 DBA::close($contacts);
977 * Fetches an array of inboxes for the given item and user
979 * @param array $item Item array
980 * @param integer $uid User ID
981 * @param boolean $personal fetch personal inboxes
982 * @param integer $last_id Last item id for adding receivers
983 * @return array with inboxes
984 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
985 * @throws \ImagickException
987 public static function fetchTargetInboxes(array $item, int $uid, bool $personal = false, int $last_id = 0): array
989 $permissions = self::createPermissionBlockForItem($item, true, true, $last_id);
990 if (empty($permissions)) {
996 if ($item['gravity'] == Item::GRAVITY_ACTIVITY) {
997 $item_profile = APContact::getByURL($item['author-link'], false);
999 $item_profile = APContact::getByURL($item['owner-link'], false);
1002 if (empty($item_profile)) {
1006 $profile_uid = User::getIdForURL($item_profile['url']);
1008 foreach (['to', 'cc', 'bto', 'bcc', 'audience'] as $element) {
1009 if (empty($permissions[$element])) {
1013 $blindcopy = in_array($element, ['bto', 'bcc']);
1015 foreach ($permissions[$element] as $receiver) {
1016 if (empty($receiver) || Network::isUrlBlocked($receiver)) {
1020 if ($item_profile && ($receiver == $item_profile['followers']) && ($uid == $profile_uid)) {
1021 $inboxes = array_merge_recursive($inboxes, self::fetchTargetInboxesforUser($uid, $personal, self::isAPPost($last_id)));
1023 $profile = APContact::getByURL($receiver, false);
1024 if (!empty($profile)) {
1025 $contact = Contact::getByURLForUser($receiver, $uid, false, ['id']);
1027 if (empty($profile['sharedinbox']) || $personal || $blindcopy || Contact::isLocal($receiver)) {
1028 $target = $profile['inbox'];
1030 $target = $profile['sharedinbox'];
1032 if (!self::archivedInbox($target) && !in_array($contact['id'], $inboxes[$target] ?? [])) {
1033 $inboxes[$target][] = $contact['id'] ?? 0;
1044 * Creates an array in the structure of the item table for a given mail id
1046 * @param integer $mail_id Mail id
1048 * @throws \Exception
1050 public static function getItemArrayFromMail(int $mail_id, bool $use_title = false): array
1052 $mail = DBA::selectFirst('mail', [], ['id' => $mail_id]);
1053 if (!DBA::isResult($mail)) {
1057 $reply = DBA::selectFirst('mail', ['uri', 'uri-id', 'from-url'], ['parent-uri' => $mail['parent-uri'], 'reply' => false]);
1058 if (!DBA::isResult($reply)) {
1062 // Making the post more compatible for Mastodon by:
1063 // - Making it a note and not an article (no title)
1064 // - Moving the title into the "summary" field that is used as a "content warning"
1067 $mail['body'] = '[abstract]' . $mail['title'] . "[/abstract]\n" . $mail['body'];
1068 $mail['title'] = '';
1071 $mail['content-warning'] = '';
1072 $mail['author-link'] = $mail['owner-link'] = $mail['from-url'];
1073 $mail['owner-id'] = $mail['author-id'];
1074 $mail['allow_cid'] = '<'.$mail['contact-id'].'>';
1075 $mail['allow_gid'] = '';
1076 $mail['deny_cid'] = '';
1077 $mail['deny_gid'] = '';
1078 $mail['private'] = Item::PRIVATE;
1079 $mail['deleted'] = false;
1080 $mail['edited'] = $mail['created'];
1081 $mail['plink'] = DI::baseUrl() . '/message/' . $mail['id'];
1082 $mail['parent-uri'] = $reply['uri'];
1083 $mail['parent-uri-id'] = $reply['uri-id'];
1084 $mail['parent-author-id'] = Contact::getIdForURL($reply['from-url'], 0, false);
1085 $mail['gravity'] = ($mail['reply'] ? Item::GRAVITY_COMMENT: Item::GRAVITY_PARENT);
1086 $mail['event-type'] = '';
1087 $mail['language'] = '';
1088 $mail['parent'] = 0;
1094 * Creates an activity array for a given mail id
1096 * @param integer $mail_id
1097 * @param boolean $object_mode Is the activity item is used inside another object?
1099 * @return array of activity
1100 * @throws \Exception
1102 public static function createActivityFromMail(int $mail_id, bool $object_mode = false): array
1104 $mail = self::getItemArrayFromMail($mail_id);
1108 $object = self::createNote($mail);
1110 if (!$object_mode) {
1111 $data = ['@context' => ActivityPub::CONTEXT];
1116 $data['id'] = $mail['uri'] . '/Create';
1117 $data['type'] = 'Create';
1118 $data['actor'] = $mail['author-link'];
1119 $data['published'] = DateTimeFormat::utc($mail['created'] . '+00:00', DateTimeFormat::ATOM);
1120 $data['instrument'] = self::getService();
1121 $data = array_merge($data, self::createPermissionBlockForItem($mail, true, false));
1123 if (empty($data['to']) && !empty($data['cc'])) {
1124 $data['to'] = $data['cc'];
1127 if (empty($data['to']) && !empty($data['bcc'])) {
1128 $data['to'] = $data['bcc'];
1132 unset($data['bcc']);
1133 unset($data['audience']);
1135 $object['to'] = $data['to'];
1136 $object['tag'] = [['type' => 'Mention', 'href' => $object['to'][0], 'name' => '']];
1138 unset($object['cc']);
1139 unset($object['bcc']);
1140 unset($object['audience']);
1142 $data['directMessage'] = true;
1144 $data['object'] = $object;
1146 $owner = User::getOwnerDataById($mail['uid']);
1148 if (!$object_mode && !empty($owner)) {
1149 return LDSignature::sign($data, $owner);
1156 * Returns the activity type of a given item
1158 * @param array $item Item array
1159 * @return string with activity type
1160 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1161 * @throws \ImagickException
1163 private static function getTypeOfItem(array $item): string
1167 // Only check for a reshare, if it is a real reshare and no quoted reshare
1168 if (strpos($item['body'], '[share') === 0) {
1169 $announce = self::getAnnounceArray($item);
1170 $reshared = !empty($announce);
1175 } elseif ($item['verb'] == Activity::POST) {
1176 if ($item['created'] == $item['edited']) {
1181 } elseif ($item['verb'] == Activity::LIKE) {
1183 } elseif ($item['verb'] == Activity::DISLIKE) {
1185 } elseif ($item['verb'] == Activity::ATTEND) {
1187 } elseif ($item['verb'] == Activity::ATTENDNO) {
1189 } elseif ($item['verb'] == Activity::ATTENDMAYBE) {
1190 $type = 'TentativeAccept';
1191 } elseif ($item['verb'] == Activity::FOLLOW) {
1193 } elseif ($item['verb'] == Activity::TAG) {
1195 } elseif ($item['verb'] == Activity::ANNOUNCE) {
1205 * Creates the activity or fetches it from the cache
1207 * @param integer $item_id Item id
1208 * @param boolean $force Force new cache entry
1209 * @param boolean $object_mode true = Create the object, false = create the activity with the object
1210 * @param boolean $announce_activity true = the announced object is the activity, false = we announce the object link
1211 * @return array|false activity or false on failure
1212 * @throws \Exception
1214 public static function createCachedActivityFromItem(int $item_id, bool $force = false, bool $object_mode = false, $announce_activity = false)
1216 $cachekey = 'APDelivery:createActivity:' . $item_id . ':' . (int)$object_mode . ':' . (int)$announce_activity;
1219 $data = DI::cache()->get($cachekey);
1220 if (!is_null($data)) {
1225 $data = self::createActivityFromItem($item_id, $object_mode, false, $announce_activity);
1227 DI::cache()->set($cachekey, $data, Duration::QUARTER_HOUR);
1232 * Creates an activity array for a given item id
1234 * @param integer $item_id
1235 * @param boolean $object_mode true = Create the object, false = create the activity with the object
1236 * @param boolean $api_mode true = used for the API
1237 * @param boolean $announce_activity true = the announced object is the activity, false = we announce the object link
1238 * @return false|array
1239 * @throws \Exception
1241 public static function createActivityFromItem(int $item_id, bool $object_mode = false, $api_mode = false, $announce_activity = false)
1243 $condition = ['id' => $item_id];
1245 $condition['parent-network'] = Protocol::NATIVE_SUPPORT;
1247 Logger::info('Fetching activity', $condition);
1248 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, $condition);
1249 if (!DBA::isResult($item)) {
1252 return self::createActivityFromArray($item, $object_mode, $api_mode, $announce_activity);
1256 * Creates an activity array for a given URI-Id and uid
1258 * @param integer $uri_id
1259 * @param integer $uid
1260 * @param boolean $object_mode true = Create the object, false = create the activity with the object
1261 * @param boolean $api_mode true = used for the API
1262 * @param boolean $announce_activity true = the announced object is the activity, false = we announce the object link
1263 * @return false|array
1264 * @throws \Exception
1266 public static function createActivityFromUriId(int $uri_id, int $uid, bool $object_mode = false, $api_mode = false, $announce_activity = false)
1268 $condition = ['uri-id' => $uri_id, 'uid' => [0, $uid]];
1270 $condition['parent-network'] = Protocol::NATIVE_SUPPORT;
1272 Logger::info('Fetching activity', $condition);
1273 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, $condition, ['order' => ['uid' => true]]);
1274 if (!DBA::isResult($item)) {
1278 return self::createActivityFromArray($item, $object_mode, $api_mode, $announce_activity);
1282 * Creates an activity array for a given item id
1284 * @param integer $item_id
1285 * @param boolean $object_mode true = Create the object, false = create the activity with the object
1286 * @param boolean $api_mode true = used for the API
1287 * @param boolean $announce_activity true = the announced object is the activity, false = we announce the object link
1288 * @return false|array
1289 * @throws \Exception
1291 private static function createActivityFromArray(array $item, bool $object_mode = false, $api_mode = false, $announce_activity = false)
1293 if (!$api_mode && !$item['deleted'] && $item['network'] == Protocol::ACTIVITYPUB) {
1294 $data = Post\Activity::getByURIId($item['uri-id']);
1295 if (!$item['origin'] && !empty($data)) {
1296 if (!$object_mode) {
1297 Logger::info('Return stored conversation', ['item' => $item['id']]);
1299 } elseif (!empty($data['object'])) {
1300 Logger::info('Return stored conversation object', ['item' => $item['id']]);
1301 return $data['object'];
1306 if (!$api_mode && !$item['origin']) {
1307 Logger::debug('Post is not ours and is not stored', ['id' => $item['id'], 'uri-id' => $item['uri-id']]);
1311 $type = self::getTypeOfItem($item);
1313 if (!$object_mode) {
1314 $data = ['@context' => $context ?? ActivityPub::CONTEXT];
1316 if ($item['deleted'] && ($item['gravity'] == Item::GRAVITY_ACTIVITY)) {
1318 } elseif ($item['deleted']) {
1325 if ($type == 'Delete') {
1326 $data['id'] = Item::newURI($item['guid']) . '/' . $type;;
1327 } elseif (($item['gravity'] == Item::GRAVITY_ACTIVITY) && ($type != 'Undo')) {
1328 $data['id'] = $item['uri'];
1330 $data['id'] = $item['uri'] . '/' . $type;
1333 $data['type'] = $type;
1335 if (($type != 'Announce') || ($item['gravity'] != Item::GRAVITY_PARENT)) {
1336 $link = $item['author-link'];
1337 $id = $item['author-id'];
1339 $link = $item['owner-link'];
1340 $id = $item['owner-id'];
1344 $data['actor'] = self::getActorArrayByCid($id);
1346 $data['actor'] = $link;
1349 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
1351 $data['instrument'] = self::getService();
1353 $data = array_merge($data, self::createPermissionBlockForItem($item, false, false));
1355 if (in_array($data['type'], ['Create', 'Update', 'Delete'])) {
1356 $data['object'] = self::createNote($item, $api_mode);
1357 } elseif ($data['type'] == 'Add') {
1358 $data = self::createAddTag($item, $data);
1359 } elseif ($data['type'] == 'Announce') {
1360 if ($item['verb'] == ACTIVITY::ANNOUNCE) {
1361 if ($announce_activity) {
1362 $anounced_item = Post::selectFirst(['uid'], ['uri-id' => $item['thr-parent-id'], 'origin' => true]);
1363 $data['object'] = self::createActivityFromUriId($item['thr-parent-id'], $anounced_item['uid'] ?? 0);
1364 unset($data['object']['@context']);
1366 $data['object'] = $item['thr-parent'];
1369 $data = self::createAnnounce($item, $data, $api_mode);
1371 } elseif ($data['type'] == 'Follow') {
1372 $data['object'] = $item['parent-uri'];
1373 } elseif ($data['type'] == 'Undo') {
1374 $data['object'] = self::createActivityFromItem($item['id'], true);
1376 $data['diaspora:guid'] = $item['guid'];
1377 if (!empty($item['signed_text'])) {
1378 $data['diaspora:like'] = $item['signed_text'];
1380 $data['object'] = $item['thr-parent'];
1383 if (!empty($item['contact-uid'])) {
1384 $uid = $item['contact-uid'];
1386 $uid = $item['uid'];
1389 Logger::info('Fetched activity', ['item' => $item['id'], 'uid' => $uid]);
1391 // We only sign our own activities
1392 if (!$api_mode && !$object_mode && $item['origin']) {
1393 $owner = User::getOwnerDataById($uid);
1394 return LDSignature::sign($data, $owner);
1399 /// @todo Create "conversation" entry
1403 * Creates a location entry for a given item array
1405 * @param array $item Item array
1406 * @return array with location array
1408 private static function createLocation(array $item): array
1410 $location = ['type' => 'Place'];
1412 if (!empty($item['location'])) {
1413 $location['name'] = $item['location'];
1418 if (empty($item['coord'])) {
1419 $coord = Map::getCoordinates($item['location']);
1421 $coords = explode(' ', $item['coord']);
1422 if (count($coords) == 2) {
1423 $coord = ['lat' => $coords[0], 'lon' => $coords[1]];
1427 if (!empty($coord['lat']) && !empty($coord['lon'])) {
1428 $location['latitude'] = $coord['lat'];
1429 $location['longitude'] = $coord['lon'];
1436 * Returns a tag array for a given item array
1438 * @param array $item Item array
1439 * @param string $quote_url Url of the attached quote link
1440 * @return array of tags
1441 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1443 private static function createTagList(array $item, string $quote_url): array
1447 $terms = Tag::getByURIId($item['uri-id'], [Tag::HASHTAG, Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1448 foreach ($terms as $term) {
1449 if ($term['type'] == Tag::HASHTAG) {
1450 $url = DI::baseUrl() . '/search?tag=' . urlencode($term['name']);
1451 $tags[] = ['type' => 'Hashtag', 'href' => $url, 'name' => '#' . $term['name']];
1453 $contact = Contact::getByURL($term['url'], false, ['addr']);
1454 if (empty($contact)) {
1457 if (!empty($contact['addr'])) {
1458 $mention = '@' . $contact['addr'];
1460 $mention = '@' . $term['url'];
1463 $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
1467 $announce = self::getAnnounceArray($item);
1468 // Mention the original author upon commented reshares
1469 if (!empty($announce['comment'])) {
1470 $tags[] = ['type' => 'Mention', 'href' => $announce['actor']['url'], 'name' => '@' . $announce['actor']['addr']];
1473 // @see https://codeberg.org/fediverse/fep/src/branch/main/feps/fep-e232.md
1474 if (!empty($quote_url)) {
1475 // Currently deactivated because of compatibility issues with Pleroma
1477 // 'type' => 'Link',
1478 // 'mediaType' => 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"',
1479 // 'href' => $quote_url,
1480 // 'name' => '♲ ' . BBCode::convertForUriId($item['uri-id'], $quote_url, BBCode::ACTIVITYPUB)
1488 * Adds attachment data to the JSON document
1490 * @param array $item Data of the item that is to be posted
1492 * @return array with attachment data
1493 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1495 private static function createAttachmentList(array $item): array
1500 foreach (Post\Media::getByURIId($item['uri-id'], [Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO, Post\Media::DOCUMENT, Post\Media::TORRENT]) as $attachment) {
1501 if (in_array($attachment['url'], $urls)) {
1504 $urls[] = $attachment['url'];
1506 $attach = ['type' => 'Document',
1507 'mediaType' => $attachment['mimetype'],
1508 'url' => $attachment['url'],
1509 'name' => $attachment['description']];
1511 if (!empty($attachment['height'])) {
1512 $attach['height'] = $attachment['height'];
1515 if (!empty($attachment['width'])) {
1516 $attach['width'] = $attachment['width'];
1519 if (!empty($attachment['preview'])) {
1520 $attach['image'] = $attachment['preview'];
1523 $attachments[] = $attach;
1526 return $attachments;
1530 * Callback function to replace a Friendica style mention in a mention for a summary
1532 * @param array $match Matching values for the callback
1533 * @return string Replaced mention
1534 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1536 private static function mentionAddrCallback(array $match): string
1538 if (empty($match[1])) {
1542 $data = Contact::getByURL($match[1], false, ['addr']);
1543 if (empty($data['addr'])) {
1547 return '@' . $data['addr'];
1551 * Remove image elements since they are added as attachment
1553 * @param string $body HTML code
1554 * @return string with removed images
1556 private static function removePictures(string $body): string
1558 return BBCode::performWithEscapedTags($body, ['code', 'noparse', 'nobb', 'pre'], function ($text) {
1559 // Simplify image codes
1560 $text = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $text);
1561 $text = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $text);
1563 // Now remove local links
1564 $text = preg_replace_callback(
1565 '/\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]/Usi',
1567 // We remove the link when it is a link to a local photo page
1568 if (Photo::isLocalPage($match[1])) {
1571 // otherwise we just return the link
1572 return '[url]' . $match[1] . '[/url]';
1577 // Remove all pictures
1578 return preg_replace("/\[img\]([^\[\]]*)\[\/img\]/Usi", '', $text);
1583 * Returns if the post contains sensitive content ("nsfw")
1585 * @param integer $uri_id URI id
1586 * @return boolean Whether URI id was found
1587 * @throws \Exception
1589 private static function isSensitive(int $uri_id): bool
1591 return DBA::exists('tag-view', ['uri-id' => $uri_id, 'name' => 'nsfw', 'type' => Tag::HASHTAG]);
1595 * Creates event data
1597 * @param array $item Item array
1598 * @return array with the event data
1599 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1601 private static function createEvent(array $item): array
1604 $event['name'] = $item['event-summary'];
1605 $event['content'] = BBCode::convertForUriId($item['uri-id'], $item['event-desc'], BBCode::ACTIVITYPUB);
1606 $event['startTime'] = DateTimeFormat::utc($item['event-start'], 'c');
1608 if (!$item['event-nofinish']) {
1609 $event['endTime'] = DateTimeFormat::utc($item['event-finish'], 'c');
1612 if (!empty($item['event-location'])) {
1613 $item['location'] = $item['event-location'];
1614 $event['location'] = self::createLocation($item);
1617 // 2021.12: Backward compatibility value, all the events now "adjust" to the viewer timezone
1618 $event['dfrn:adjust'] = true;
1624 * Creates a note/article object array
1626 * @param array $item
1627 * @param bool $api_mode
1628 * @return array with the object data
1629 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1630 * @throws \ImagickException
1632 public static function createNote(array $item, bool $api_mode = false): array
1638 // We are treating posts differently when they are directed to a community.
1639 // This is done to better support Lemmy. Most of the changes should work with other systems as well.
1640 // But to not risk compatibility issues we currently perform the changes only for communities.
1641 if ($item['gravity'] == Item::GRAVITY_PARENT) {
1642 $isCommunityPost = !empty(Tag::getByURIId($item['uri-id'], [Tag::EXCLUSIVE_MENTION]));
1643 $links = Post\Media::getByURIId($item['uri-id'], [Post\Media::HTML]);
1644 if ($isCommunityPost && (count($links) == 1)) {
1645 $link = $links[0]['url'];
1648 $isCommunityPost = false;
1651 if ($item['event-type'] == 'event') {
1653 } elseif (!empty($item['title'])) {
1654 if (!$isCommunityPost || empty($link)) {
1657 // "Page" is used by Lemmy for posts that contain an external link
1664 if ($item['deleted']) {
1665 $type = 'Tombstone';
1669 $data['id'] = $item['uri'];
1670 $data['type'] = $type;
1672 if ($item['deleted']) {
1676 $data['summary'] = BBCode::toPlaintext(BBCode::getAbstract($item['body'], Protocol::ACTIVITYPUB));
1678 if ($item['uri'] != $item['thr-parent']) {
1679 $data['inReplyTo'] = $item['thr-parent'];
1681 $data['inReplyTo'] = null;
1684 $data['diaspora:guid'] = $item['guid'];
1685 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
1687 if ($item['created'] != $item['edited']) {
1688 $data['updated'] = DateTimeFormat::utc($item['edited'] . '+00:00', DateTimeFormat::ATOM);
1691 $data['url'] = $link ?? $item['plink'];
1693 $data['attributedTo'] = self::getActorArrayByCid($item['author-id']);
1695 $data['attributedTo'] = $item['author-link'];
1697 $data['sensitive'] = self::isSensitive($item['uri-id']);
1699 if (!empty($item['conversation']) && ($item['conversation'] != './')) {
1700 $data['conversation'] = $data['context'] = $item['conversation'];
1703 if (!empty($item['title'])) {
1704 $data['name'] = BBCode::toPlaintext($item['title'], false);
1707 $permission_block = self::createPermissionBlockForItem($item, false, false);
1709 $real_quote = false;
1711 $item = Post\Media::addHTMLAttachmentToItem($item);
1713 $body = $item['body'];
1715 if ($type == 'Note') {
1716 $body = $item['raw-body'] ?? self::removePictures($body);
1720 * @todo Improve the automated summary
1721 * This part is currently deactivated. The automated summary seems to be more
1722 * confusing than helping. But possibly we will find a better way.
1723 * So the code is left here for now as a reminder
1725 * } elseif (($type == 'Article') && empty($data['summary'])) {
1726 * $regexp = "/[@!]\[url\=([^\[\]]*)\].*?\[\/url\]/ism";
1727 * $summary = preg_replace_callback($regexp, [self::class, 'mentionAddrCallback'], $body);
1728 * $data['summary'] = BBCode::toPlaintext(Plaintext::shorten(self::removePictures($summary), 1000));
1732 if (empty($item['uid']) || !Feature::isEnabled($item['uid'], 'explicit_mentions')) {
1733 $body = self::prependMentions($body, $item['uri-id'], $item['author-link']);
1736 if ($type == 'Event') {
1737 $data = array_merge($data, self::createEvent($item));
1739 if ($isCommunityPost) {
1740 // For community posts we remove the visible "!user@domain.tld".
1741 // This improves the look at systems like Lemmy.
1742 // Also in the future we should control the community delivery via other methods.
1743 $body = preg_replace("/!\[url\=[^\[\]]*\][^\[\]]*\[\/url\]/ism", '', $body);
1746 if ($type == 'Page') {
1747 // When we transmit "Page" posts we have to remove the attachment.
1748 // The attachment contains the link that we already transmit in the "url" field.
1749 $body = BBCode::removeAttachment($body);
1752 $body = BBCode::setMentionsToNicknames($body);
1754 if (!empty($item['quote-uri-id'])) {
1755 if (Post::exists(['uri-id' => $item['quote-uri-id'], 'network' => [Protocol::ACTIVITYPUB, Protocol::DFRN]])) {
1757 $data['quoteUrl'] = $item['quote-uri'];
1758 $body = DI::contentItem()->addShareLink($body, $item['quote-uri-id']);
1760 $body = DI::contentItem()->addSharedPost($item, $body);
1764 $data['content'] = BBCode::convertForUriId($item['uri-id'], $body, BBCode::ACTIVITYPUB);
1767 // The regular "content" field does contain a minimized HTML. This is done since systems like
1768 // Mastodon has got problems with - for example - embedded pictures.
1769 // The contentMap does contain the unmodified HTML.
1770 $language = self::getLanguage($item);
1771 if (!empty($language)) {
1772 $richbody = BBCode::setMentionsToNicknames($item['body'] ?? '');
1773 $richbody = Post\Media::removeFromEndOfBody($richbody);
1774 if (!empty($item['quote-uri-id'])) {
1776 $richbody = DI::contentItem()->addShareLink($richbody, $item['quote-uri-id']);
1778 $richbody = DI::contentItem()->addSharedPost($item, $richbody);
1781 $richbody = BBCode::replaceAttachment($richbody);
1783 $data['contentMap'][$language] = BBCode::convertForUriId($item['uri-id'], $richbody, BBCode::EXTERNAL);
1786 if (!empty($item['quote-uri-id'])) {
1787 $source = DI::contentItem()->addSharedPost($item, $item['body']);
1789 $source = $item['body'];
1792 $data['source'] = ['content' => $source, 'mediaType' => "text/bbcode"];
1794 if (!empty($item['signed_text']) && ($item['uri'] != $item['thr-parent'])) {
1795 $data['diaspora:comment'] = $item['signed_text'];
1798 $data['attachment'] = self::createAttachmentList($item);
1799 $data['tag'] = self::createTagList($item, $data['quoteUrl'] ?? '');
1801 if (empty($data['location']) && (!empty($item['coord']) || !empty($item['location']))) {
1802 $data['location'] = self::createLocation($item);
1805 if (!empty($item['app'])) {
1806 $data['generator'] = ['type' => 'Application', 'name' => $item['app']];
1809 $data = array_merge($data, $permission_block);
1815 * Fetches the language from the post, the user or the system.
1817 * @param array $item
1818 * @return string language string
1820 private static function getLanguage(array $item): string
1822 // Try to fetch the language from the post itself
1823 if (!empty($item['language'])) {
1824 $languages = array_keys(json_decode($item['language'], true));
1825 if (!empty($languages[0])) {
1826 return $languages[0];
1830 // Otherwise use the user's language
1831 if (!empty($item['uid'])) {
1832 $user = DBA::selectFirst('user', ['language'], ['uid' => $item['uid']]);
1833 if (!empty($user['language'])) {
1834 return $user['language'];
1838 // And finally just use the system language
1839 return DI::config()->get('system', 'language');
1843 * Creates an an "add tag" entry
1845 * @param array $item Item array
1846 * @param array $activity activity data
1847 * @return array with activity data for adding tags
1848 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1849 * @throws \ImagickException
1851 private static function createAddTag(array $item, array $activity): array
1853 $object = XML::parseString($item['object']);
1854 $target = XML::parseString($item['target']);
1856 $activity['diaspora:guid'] = $item['guid'];
1857 $activity['actor'] = $item['author-link'];
1858 $activity['target'] = (string)$target->id;
1859 $activity['summary'] = BBCode::toPlaintext($item['body']);
1860 $activity['object'] = ['id' => (string)$object->id, 'type' => 'tag', 'name' => (string)$object->title, 'content' => (string)$object->content];
1866 * Creates an announce object entry
1868 * @param array $item Item array
1869 * @param array $activity activity data
1870 * @param bool $api_mode
1871 * @return array with activity data
1872 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1873 * @throws \ImagickException
1875 private static function createAnnounce(array $item, array $activity, bool $api_mode = false): array
1877 $orig_body = $item['body'];
1878 $announce = self::getAnnounceArray($item);
1879 if (empty($announce)) {
1880 $activity['type'] = 'Create';
1881 $activity['object'] = self::createNote($item, $api_mode);
1885 if (empty($announce['comment'])) {
1886 // Pure announce, without a quote
1887 $activity['type'] = 'Announce';
1888 $activity['object'] = $announce['object']['uri'];
1893 $activity['type'] = 'Create';
1894 $item['body'] = $announce['comment'] . "\n" . $announce['object']['plink'];
1895 $activity['object'] = self::createNote($item, $api_mode);
1897 /// @todo Finally decide how to implement this in AP. This is a possible way:
1898 $activity['object']['attachment'][] = self::createNote($announce['object']);
1900 $activity['object']['source']['content'] = $orig_body;
1905 * Return announce related data if the item is an announce
1907 * @param array $item
1908 * @return array Announcement array
1910 private static function getAnnounceArray(array $item): array
1912 $reshared = DI::contentItem()->getSharedPost($item, Item::DELIVER_FIELDLIST);
1913 if (empty($reshared)) {
1917 if (!in_array($reshared['post']['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
1921 $profile = APContact::getByURL($reshared['post']['author-link'], false);
1922 if (empty($profile)) {
1926 return ['object' => $reshared['post'], 'actor' => $profile, 'comment' => $reshared['comment']];
1930 * Checks if the provided item array is an announce
1932 * @param array $item Item array
1933 * @return boolean Whether item is an announcement
1935 public static function isAnnounce(array $item): bool
1937 if (!empty($item['verb']) && ($item['verb'] == Activity::ANNOUNCE)) {
1941 $announce = self::getAnnounceArray($item);
1942 if (empty($announce)) {
1946 return empty($announce['comment']);
1950 * Creates an activity id for a given contact id
1952 * @param integer $cid Contact ID of target
1954 * @return bool|string activity id
1956 public static function activityIDFromContact(int $cid)
1958 $contact = DBA::selectFirst('contact', ['uid', 'id', 'created'], ['id' => $cid]);
1959 if (!DBA::isResult($contact)) {
1963 $hash = hash('ripemd128', $contact['uid'].'-'.$contact['id'].'-'.$contact['created']);
1964 $uuid = substr($hash, 0, 8). '-' . substr($hash, 8, 4) . '-' . substr($hash, 12, 4) . '-' . substr($hash, 16, 4) . '-' . substr($hash, 20, 12);
1965 return DI::baseUrl() . '/activity/' . $uuid;
1969 * Transmits a contact suggestion to a given inbox
1971 * @param array $owner Sender owner-view record
1972 * @param string $inbox Target inbox
1973 * @param integer $suggestion_id Suggestion ID
1974 * @return boolean was the transmission successful?
1975 * @throws \Exception
1977 public static function sendContactSuggestion(array $owner, string $inbox, int $suggestion_id): bool
1979 $suggestion = DI::fsuggest()->selectOneById($suggestion_id);
1982 '@context' => ActivityPub::CONTEXT,
1983 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1984 'type' => 'Announce',
1985 'actor' => $owner['url'],
1986 'object' => $suggestion->url,
1987 'content' => $suggestion->note,
1988 'instrument' => self::getService(),
1989 'to' => [ActivityPub::PUBLIC_COLLECTION],
1993 $signed = LDSignature::sign($data, $owner);
1995 Logger::info('Deliver profile deletion for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
1996 return HTTPSignature::transmit($signed, $inbox, $owner);
2000 * Transmits a profile relocation to a given inbox
2002 * @param array $owner Sender owner-view record
2003 * @param string $inbox Target inbox
2004 * @return boolean was the transmission successful?
2005 * @throws \Exception
2007 public static function sendProfileRelocation(array $owner, string $inbox): bool
2010 '@context' => ActivityPub::CONTEXT,
2011 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2012 'type' => 'dfrn:relocate',
2013 'actor' => $owner['url'],
2014 'object' => $owner['url'],
2015 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
2016 'instrument' => self::getService(),
2017 'to' => [ActivityPub::PUBLIC_COLLECTION],
2021 $signed = LDSignature::sign($data, $owner);
2023 Logger::info('Deliver profile relocation for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
2024 return HTTPSignature::transmit($signed, $inbox, $owner);
2028 * Transmits a profile deletion to a given inbox
2030 * @param array $owner Sender owner-view record
2031 * @param string $inbox Target inbox
2032 * @return boolean was the transmission successful?
2033 * @throws \Exception
2035 public static function sendProfileDeletion(array $owner, string $inbox): bool
2037 if (empty($owner['uprvkey'])) {
2038 Logger::error('No private key for owner found, the deletion message cannot be processed.', ['user' => $owner['uid']]);
2042 $data = ['@context' => ActivityPub::CONTEXT,
2043 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2045 'actor' => $owner['url'],
2046 'object' => $owner['url'],
2047 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
2048 'instrument' => self::getService(),
2049 'to' => [ActivityPub::PUBLIC_COLLECTION],
2052 $signed = LDSignature::sign($data, $owner);
2054 Logger::info('Deliver profile deletion for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
2055 return HTTPSignature::transmit($signed, $inbox, $owner);
2059 * Transmits a profile change to a given inbox
2061 * @param array $owner Sender owner-view record
2062 * @param string $inbox Target inbox
2063 * @return boolean was the transmission successful?
2064 * @throws HTTPException\InternalServerErrorException
2065 * @throws HTTPException\NotFoundException
2066 * @throws \ImagickException
2068 public static function sendProfileUpdate(array $owner, string $inbox): bool
2070 $profile = APContact::getByURL($owner['url']);
2072 $data = ['@context' => ActivityPub::CONTEXT,
2073 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2075 'actor' => $owner['url'],
2076 'object' => self::getProfile($owner['uid']),
2077 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
2078 'instrument' => self::getService(),
2079 'to' => [$profile['followers']],
2082 $signed = LDSignature::sign($data, $owner);
2084 Logger::info('Deliver profile update for user ' . $owner['uid'] . ' to ' . $inbox . ' via ActivityPub');
2085 return HTTPSignature::transmit($signed, $inbox, $owner);
2089 * Transmits a given activity to a target
2091 * @param string $activity Type name
2092 * @param string $target Target profile
2093 * @param integer $uid User ID
2094 * @param string $id Activity-identifier
2096 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2097 * @throws \ImagickException
2098 * @throws \Exception
2100 public static function sendActivity(string $activity, string $target, int $uid, string $id = ''): bool
2102 $profile = APContact::getByURL($target);
2103 if (empty($profile['inbox'])) {
2104 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2108 $owner = User::getOwnerDataById($uid);
2109 if (empty($owner)) {
2110 Logger::warning('No user found for actor, aborting', ['uid' => $uid]);
2115 $id = DI::baseUrl() . '/activity/' . System::createGUID();
2119 '@context' => ActivityPub::CONTEXT,
2121 'type' => $activity,
2122 'actor' => $owner['url'],
2123 'object' => $profile['url'],
2124 'instrument' => self::getService(),
2125 'to' => [$profile['url']],
2128 Logger::info('Sending activity ' . $activity . ' to ' . $target . ' for user ' . $uid);
2130 $signed = LDSignature::sign($data, $owner);
2131 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2135 * Transmits a "follow object" activity to a target
2136 * This is a preparation for sending automated "follow" requests when receiving "Announce" messages
2138 * @param string $object Object URL
2139 * @param string $target Target profile
2140 * @param integer $uid User ID
2142 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2143 * @throws \ImagickException
2144 * @throws \Exception
2146 public static function sendFollowObject(string $object, string $target, int $uid = 0): bool
2148 $profile = APContact::getByURL($target);
2149 if (empty($profile['inbox'])) {
2150 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2155 // We need to use some user as a sender. It doesn't care who it will send. We will use an administrator account.
2156 $admin = User::getFirstAdmin(['uid']);
2158 Logger::warning('No available admin user for transmission', ['target' => $target]);
2162 $uid = $admin['uid'];
2165 $condition = ['verb' => Activity::FOLLOW, 'uid' => 0, 'parent-uri' => $object,
2166 'author-id' => Contact::getPublicIdByUserId($uid)];
2167 if (Post::exists($condition)) {
2168 Logger::info('Follow for ' . $object . ' for user ' . $uid . ' does already exist.');
2172 $owner = User::getOwnerDataById($uid);
2175 '@context' => ActivityPub::CONTEXT,
2176 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2178 'actor' => $owner['url'],
2179 'object' => $object,
2180 'instrument' => self::getService(),
2181 'to' => [$profile['url']],
2184 Logger::info('Sending follow ' . $object . ' to ' . $target . ' for user ' . $uid);
2186 $signed = LDSignature::sign($data, $owner);
2187 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2191 * Transmit a message that the contact request had been accepted
2193 * @param string $target Target profile
2194 * @param string $id Object id
2195 * @param integer $uid User ID
2197 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2198 * @throws \ImagickException
2200 public static function sendContactAccept(string $target, string $id, int $uid)
2202 $profile = APContact::getByURL($target);
2203 if (empty($profile['inbox'])) {
2204 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2208 $owner = User::getOwnerDataById($uid);
2210 Logger::notice('No user found for actor', ['uid' => $uid]);
2215 '@context' => ActivityPub::CONTEXT,
2216 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2218 'actor' => $owner['url'],
2222 'actor' => $profile['url'],
2223 'object' => $owner['url']
2225 'instrument' => self::getService(),
2226 'to' => [$profile['url']],
2229 Logger::debug('Sending accept to ' . $target . ' for user ' . $uid . ' with id ' . $id);
2231 $signed = LDSignature::sign($data, $owner);
2232 HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2236 * Reject a contact request or terminates the contact relation
2238 * @param string $target Target profile
2239 * @param string $objectId Object id
2240 * @param array $owner Sender owner-view record
2241 * @return bool Operation success
2242 * @throws HTTPException\InternalServerErrorException
2243 * @throws \ImagickException
2245 public static function sendContactReject(string $target, string $objectId, array $owner): bool
2247 $profile = APContact::getByURL($target);
2248 if (empty($profile['inbox'])) {
2249 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2254 '@context' => ActivityPub::CONTEXT,
2255 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2257 'actor' => $owner['url'],
2261 'actor' => $profile['url'],
2262 'object' => $owner['url']
2264 'instrument' => self::getService(),
2265 'to' => [$profile['url']],
2268 Logger::debug('Sending reject to ' . $target . ' for user ' . $owner['uid'] . ' with id ' . $objectId);
2270 $signed = LDSignature::sign($data, $owner);
2271 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2275 * Transmits a message that we don't want to follow this contact anymore
2277 * @param string $target Target profile
2278 * @param integer $cid Contact id
2279 * @param array $owner Sender owner-view record
2280 * @return bool success
2281 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2282 * @throws \ImagickException
2283 * @throws \Exception
2285 public static function sendContactUndo(string $target, int $cid, array $owner): bool
2287 $profile = APContact::getByURL($target);
2288 if (empty($profile['inbox'])) {
2289 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2293 $object_id = self::activityIDFromContact($cid);
2294 if (empty($object_id)) {
2298 $objectId = DI::baseUrl() . '/activity/' . System::createGUID();
2301 '@context' => ActivityPub::CONTEXT,
2304 'actor' => $owner['url'],
2308 'actor' => $owner['url'],
2309 'object' => $profile['url']
2311 'instrument' => self::getService(),
2312 'to' => [$profile['url']],
2315 Logger::info('Sending undo to ' . $target . ' for user ' . $owner['uid'] . ' with id ' . $objectId);
2317 $signed = LDSignature::sign($data, $owner);
2318 return HTTPSignature::transmit($signed, $profile['inbox'], $owner);
2322 * Prepends mentions (@) to $body variable
2324 * @param string $body HTML code
2326 * @param string $authorLink Author link
2327 * @return string HTML code with prepended mentions
2329 private static function prependMentions(string $body, int $uriid, string $authorLink): string
2333 foreach (Tag::getByURIId($uriid, [Tag::IMPLICIT_MENTION]) as $tag) {
2334 $profile = Contact::getByURL($tag['url'], false, ['addr', 'contact-type', 'nick']);
2335 if (!empty($profile['addr'])
2336 && $profile['contact-type'] != Contact::TYPE_COMMUNITY
2337 && !strstr($body, $profile['addr'])
2338 && !strstr($body, $tag['url'])
2339 && $tag['url'] !== $authorLink
2341 $mentions[] = '@[url=' . $tag['url'] . ']' . $profile['nick'] . '[/url]';
2345 $mentions[] = $body;
2347 return implode(' ', $mentions);