3 * @copyright Copyright (C) 2010-2022, the Friendica project
5 * @license GNU AGPL version 3 or any later version
7 * This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as
9 * published by the Free Software Foundation, either version 3 of the
10 * License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <https://www.gnu.org/licenses/>.
22 namespace Friendica\Protocol\ActivityPub;
24 use Friendica\Content\Feature;
25 use Friendica\Content\Text\BBCode;
26 use Friendica\Core\Cache\Enum\Duration;
27 use Friendica\Core\Logger;
28 use Friendica\Core\Protocol;
29 use Friendica\Core\System;
30 use Friendica\Database\DBA;
32 use Friendica\Model\APContact;
33 use Friendica\Model\Contact;
34 use Friendica\Model\Conversation;
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\JsonLD;
48 use Friendica\Util\LDSignature;
49 use Friendica\Util\Map;
50 use Friendica\Util\Network;
51 use Friendica\Util\Strings;
52 use Friendica\Util\XML;
55 * ActivityPub Transmitter Protocol class
63 * Add relay servers to the list of inboxes
65 * @param array $inboxes
66 * @return array inboxes with added relay servers
68 public static function addRelayServerInboxes(array $inboxes = [])
70 foreach (Relay::getList(['inbox']) as $contact) {
71 $inboxes[$contact['inbox']] = $contact['inbox'];
78 * Add relay servers to the list of inboxes
80 * @param array $inboxes
81 * @return array inboxes with added relay servers
83 public static function addRelayServerInboxesForItem(int $item_id, array $inboxes = [])
85 $item = Post::selectFirst(['uid'], ['id' => $item_id]);
90 $relays = Relay::getDirectRelayList($item_id);
95 foreach ($relays as $relay) {
96 $contact = Contact::getByURLForUser($relay['url'], $item['uid'], false, ['id']);
97 $inboxes[$relay['batch']][] = $contact['id'] ?? 0;
103 * Subscribe to a relay
105 * @param string $url Subscribe actor url
106 * @return bool success
108 public static function sendRelayFollow(string $url)
110 $contact = Contact::getByURL($url);
111 if (empty($contact)) {
115 $activity_id = ActivityPub\Transmitter::activityIDFromContact($contact['id']);
116 $success = ActivityPub\Transmitter::sendActivity('Follow', $url, 0, $activity_id);
118 Contact::update(['rel' => Contact::FRIEND], ['id' => $contact['id']]);
125 * Unsubscribe from a relay
127 * @param string $url Subscribe actor url
128 * @param bool $force Set the relay status as non follower even if unsubscribe hadn't worked
129 * @return bool success
131 public static function sendRelayUndoFollow(string $url, bool $force = false)
133 $contact = Contact::getByURL($url);
134 if (empty($contact)) {
138 $success = self::sendContactUndo($url, $contact['id'], 0);
139 if ($success || $force) {
140 Contact::update(['rel' => Contact::NOTHING], ['id' => $contact['id']]);
147 * Collects a list of contacts of the given owner
149 * @param array $owner Owner array
150 * @param int|array $rel The relevant value(s) contact.rel should match
151 * @param string $module The name of the relevant AP endpoint module (followers|following)
152 * @param integer $page Page number
153 * @param string $requester URL of the requester
155 * @return array of owners
158 public static function getContacts($owner, $rel, $module, $page = null, string $requester = null)
162 'uid' => $owner['uid'],
171 $condition = DBA::mergeConditions($parameters, ["`url` IN (SELECT `url` FROM `apcontact`)"]);
173 $total = DBA::count('contact', $condition);
175 $modulePath = '/' . $module . '/';
177 $data = ['@context' => ActivityPub::CONTEXT];
178 $data['id'] = DI::baseUrl() . $modulePath . $owner['nickname'];
179 $data['type'] = 'OrderedCollection';
180 $data['totalItems'] = $total;
182 // When we hide our friends we will only show the pure number but don't allow more.
183 $show_contacts = empty($owner['hide-friends']);
185 // Allow fetching the contact list when the requester is part of the list.
186 if (($owner['page-flags'] == User::PAGE_FLAGS_PRVGROUP) && !empty($requester)) {
187 $show_contacts = DBA::exists('contact', ['nurl' => Strings::normaliseLink($requester), 'uid' => $owner['uid'], 'blocked' => false]);
190 if (!$show_contacts) {
195 $data['first'] = DI::baseUrl() . $modulePath . $owner['nickname'] . '?page=1';
197 $data['type'] = 'OrderedCollectionPage';
200 $contacts = DBA::select('contact', ['url'], $condition, ['limit' => [($page - 1) * 100, 100]]);
201 while ($contact = DBA::fetch($contacts)) {
202 $list[] = $contact['url'];
204 DBA::close($contacts);
207 $data['next'] = DI::baseUrl() . $modulePath . $owner['nickname'] . '?page=' . ($page + 1);
210 $data['partOf'] = DI::baseUrl() . $modulePath . $owner['nickname'];
212 $data['orderedItems'] = $list;
219 * Public posts for the given owner
221 * @param array $owner Owner array
222 * @param integer $page Page number
223 * @param string $requester URL of requesting account
225 * @return array of posts
226 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
227 * @throws \ImagickException
229 public static function getOutbox($owner, $page = null, $requester = '')
231 $condition = ['private' => [Item::PUBLIC, Item::UNLISTED]];
233 if (!empty($requester)) {
234 $requester_id = Contact::getIdForURL($requester, $owner['uid']);
235 if (!empty($requester_id)) {
236 $permissionSets = DI::permissionSet()->selectByContactId($requester_id, $owner['uid']);
237 if (!empty($permissionSets)) {
238 $condition = ['psid' => array_merge($permissionSets->column('id'),
239 [DI::permissionSet()->selectPublicForUser($owner['uid'])])];
244 $condition = array_merge($condition,
245 ['uid' => $owner['uid'],
246 'author-id' => Contact::getIdForURL($owner['url'], 0, false),
247 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
248 'network' => Protocol::FEDERATED,
249 'parent-network' => Protocol::FEDERATED,
254 $count = Post::count($condition);
256 $data = ['@context' => ActivityPub::CONTEXT];
257 $data['id'] = DI::baseUrl() . '/outbox/' . $owner['nickname'];
258 $data['type'] = 'OrderedCollection';
259 $data['totalItems'] = $count;
262 $data['first'] = DI::baseUrl() . '/outbox/' . $owner['nickname'] . '?page=1';
264 $data['type'] = 'OrderedCollectionPage';
267 $items = Post::select(['id'], $condition, ['limit' => [($page - 1) * 20, 20], 'order' => ['created' => true]]);
268 while ($item = Post::fetch($items)) {
269 $activity = self::createActivityFromItem($item['id'], true);
270 $activity['type'] = $activity['type'] == 'Update' ? 'Create' : $activity['type'];
272 // Only list "Create" activity objects here, no reshares
273 if (!empty($activity['object']) && ($activity['type'] == 'Create')) {
274 $list[] = $activity['object'];
280 $data['next'] = DI::baseUrl() . '/outbox/' . $owner['nickname'] . '?page=' . ($page + 1);
283 $data['partOf'] = DI::baseUrl() . '/outbox/' . $owner['nickname'];
285 $data['orderedItems'] = $list;
292 * Return the service array containing information the used software and it's url
294 * @return array with service data
296 private static function getService()
298 return ['type' => 'Service',
299 'name' => FRIENDICA_PLATFORM . " '" . FRIENDICA_CODENAME . "' " . FRIENDICA_VERSION . '-' . DB_UPDATE_VERSION,
300 'url' => DI::baseUrl()->get()];
304 * Return the ActivityPub profile of the given user
306 * @param int $uid User ID
307 * @return array with profile data
308 * @throws HTTPException\NotFoundException
309 * @throws HTTPException\InternalServerErrorException
311 public static function getProfile(int $uid): array
313 $owner = User::getOwnerDataById($uid);
314 if (!isset($owner['id'])) {
315 DI::logger()->error('Unable to find owner data for uid', ['uid' => $uid, 'callstack' => System::callstack(20)]);
316 throw new HTTPException\NotFoundException('User not found.');
319 $data = ['@context' => ActivityPub::CONTEXT];
320 $data['id'] = $owner['url'];
322 if (!empty($owner['guid'])) {
323 $data['diaspora:guid'] = $owner['guid'];
326 $data['type'] = ActivityPub::ACCOUNT_TYPES[$owner['account-type']];
329 $data['following'] = DI::baseUrl() . '/following/' . $owner['nick'];
330 $data['followers'] = DI::baseUrl() . '/followers/' . $owner['nick'];
331 $data['inbox'] = DI::baseUrl() . '/inbox/' . $owner['nick'];
332 $data['outbox'] = DI::baseUrl() . '/outbox/' . $owner['nick'];
334 $data['inbox'] = DI::baseUrl() . '/friendica/inbox';
337 $data['preferredUsername'] = $owner['nick'];
338 $data['name'] = $owner['name'];
340 if (!empty($owner['country-name'] . $owner['region'] . $owner['locality'])) {
341 $data['vcard:hasAddress'] = ['@type' => 'vcard:Home', 'vcard:country-name' => $owner['country-name'],
342 'vcard:region' => $owner['region'], 'vcard:locality' => $owner['locality']];
345 if (!empty($owner['about'])) {
346 $data['summary'] = BBCode::convertForUriId($owner['uri-id'] ?? 0, $owner['about'], BBCode::EXTERNAL);
349 if (!empty($owner['xmpp']) || !empty($owner['matrix'])) {
350 $data['vcard:hasInstantMessage'] = [];
352 if (!empty($owner['xmpp'])) {
353 $data['vcard:hasInstantMessage'][] = 'xmpp:' . $owner['xmpp'];
355 if (!empty($owner['matrix'])) {
356 $data['vcard:hasInstantMessage'][] = 'matrix:' . $owner['matrix'];
360 $data['url'] = $owner['url'];
361 $data['manuallyApprovesFollowers'] = in_array($owner['page-flags'], [User::PAGE_FLAGS_NORMAL, User::PAGE_FLAGS_PRVGROUP]);
362 $data['discoverable'] = (bool)$owner['net-publish'];
363 $data['publicKey'] = ['id' => $owner['url'] . '#main-key',
364 'owner' => $owner['url'],
365 'publicKeyPem' => $owner['pubkey']];
366 $data['endpoints'] = ['sharedInbox' => DI::baseUrl() . '/inbox'];
367 $data['icon'] = ['type' => 'Image', 'url' => User::getAvatarUrl($owner)];
369 $resourceid = Photo::ridFromURI($owner['photo']);
370 if (!empty($resourceid)) {
371 $photo = Photo::selectFirst(['type'], ["resource-id" => $resourceid]);
372 if (!empty($photo['type'])) {
373 $data['icon']['mediaType'] = $photo['type'];
377 if (!empty($owner['header'])) {
378 $data['image'] = ['type' => 'Image', 'url' => Contact::getHeaderUrlForId($owner['id'], '', $owner['updated'])];
380 $resourceid = Photo::ridFromURI($owner['header']);
381 if (!empty($resourceid)) {
382 $photo = Photo::selectFirst(['type'], ["resource-id" => $resourceid]);
383 if (!empty($photo['type'])) {
384 $data['image']['mediaType'] = $photo['type'];
391 foreach (DI::profileField()->selectByContactId(0, $uid) as $profile_field) {
393 'type' => 'PropertyValue',
394 'name' => $profile_field->label,
395 'value' => BBCode::convertForUriId($owner['uri-id'], $profile_field->value)
399 if (!empty($custom_fields)) {
400 $data['attachment'] = $custom_fields;
403 $data['generator'] = self::getService();
405 // tags: https://kitty.town/@inmysocks/100656097926961126.json
410 * @param string $username
412 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
414 public static function getDeletedUser($username)
417 '@context' => ActivityPub::CONTEXT,
418 'id' => DI::baseUrl() . '/profile/' . $username,
419 'type' => 'Tombstone',
420 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
421 'updated' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
422 'deleted' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
427 * Returns an array with permissions of the thread parent of the given item array
431 * @return array with permissions
432 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
433 * @throws \ImagickException
435 public static function fetchPermissionBlockFromThreadParent($item)
437 if (empty($item['thr-parent-id'])) {
441 $parent = Post::selectFirstPost(['author-link'], ['uri-id' => $item['thr-parent-id']]);
442 if (empty($parent)) {
447 'to' => [$parent['author-link']],
453 $parent_profile = APContact::getByURL($parent['author-link']);
455 $item_profile = APContact::getByURL($item['author-link']);
456 $exclude[] = $item['author-link'];
458 if ($item['gravity'] == GRAVITY_PARENT) {
459 $exclude[] = $item['owner-link'];
462 $type = [Tag::TO => 'to', Tag::CC => 'cc', Tag::BTO => 'bto', Tag::BCC => 'bcc'];
463 foreach (Tag::getByURIId($item['thr-parent-id'], [Tag::TO, Tag::CC, Tag::BTO, Tag::BCC]) as $receiver) {
464 if (!empty($parent_profile['followers']) && $receiver['url'] == $parent_profile['followers'] && !empty($item_profile['followers'])) {
465 $permissions[$type[$receiver['type']]][] = $item_profile['followers'];
466 } elseif (!in_array($receiver['url'], $exclude)) {
467 $permissions[$type[$receiver['type']]][] = $receiver['url'];
475 * Check if the given item id is from ActivityPub
477 * @param integer $item_id
478 * @return boolean "true" if the post is from ActivityPub
480 private static function isAPPost(int $item_id)
482 if (empty($item_id)) {
486 return Post::exists(['id' => $item_id, 'network' => Protocol::ACTIVITYPUB]);
490 * Creates an array of permissions from an item thread
492 * @param array $item Item array
493 * @param boolean $blindcopy addressing via "bcc" or "cc"?
494 * @param integer $last_id Last item id for adding receivers
496 * @return array with permission data
497 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
498 * @throws \ImagickException
500 private static function createPermissionBlockForItem($item, $blindcopy, $last_id = 0)
503 $last_id = $item['id'];
510 // Check if we should always deliver our stuff via BCC
511 if (!empty($item['uid'])) {
512 $owner = User::getOwnerDataById($item['uid']);
513 if (!empty($owner)) {
514 $always_bcc = $owner['hide-friends'];
515 $is_forum = ($owner['account-type'] == User::ACCOUNT_TYPE_COMMUNITY) && $owner['manually-approve'];
517 $profile = APContact::getByURL($owner['url'], false);
518 $follower = $profile['followers'] ?? '';
522 if (DI::config()->get('system', 'ap_always_bcc')) {
526 if (self::isAnnounce($item) || DI::config()->get('debug', 'total_ap_delivery') || self::isAPPost($last_id)) {
527 // Will be activated in a later step
528 $networks = Protocol::FEDERATED;
530 // For now only send to these contacts:
531 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
534 $data = ['to' => [], 'cc' => [], 'bcc' => []];
536 if ($item['gravity'] == GRAVITY_PARENT) {
537 $actor_profile = APContact::getByURL($item['owner-link']);
539 $actor_profile = APContact::getByURL($item['author-link']);
544 $terms = Tag::getByURIId($item['uri-id'], [Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
546 if ($item['private'] != Item::PRIVATE) {
547 // Directly mention the original author upon a quoted reshare.
548 // Else just ensure that the original author receives the reshare.
549 $announce = self::getAnnounceArray($item);
550 if (!empty($announce['comment'])) {
551 $data['to'][] = $announce['actor']['url'];
552 } elseif (!empty($announce)) {
553 $data['cc'][] = $announce['actor']['url'];
556 $data = array_merge($data, self::fetchPermissionBlockFromThreadParent($item));
558 // Check if the item is completely public or unlisted
559 if ($item['private'] == Item::PUBLIC) {
560 $data['to'][] = ActivityPub::PUBLIC_COLLECTION;
562 $data['cc'][] = ActivityPub::PUBLIC_COLLECTION;
565 foreach ($terms as $term) {
566 $profile = APContact::getByURL($term['url'], false);
567 if (!empty($profile)) {
568 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
570 if (!empty($profile['followers']) && ($profile['type'] == 'Group')) {
571 $data['cc'][] = $profile['followers'];
574 $data['to'][] = $profile['url'];
578 $receiver_list = Item::enumeratePermissions($item, true);
580 foreach ($terms as $term) {
581 $cid = Contact::getIdForURL($term['url'], $item['uid']);
582 if (!empty($cid) && in_array($cid, $receiver_list)) {
583 $contact = DBA::selectFirst('contact', ['url', 'network', 'protocol', 'gsid'], ['id' => $cid, 'network' => Protocol::FEDERATED]);
584 if (!DBA::isResult($contact) || !self::isAPContact($contact, $networks)) {
588 $profile = APContact::getByURL($term['url'], false);
589 if (!empty($profile)) {
590 if ($term['type'] == Tag::EXCLUSIVE_MENTION) {
592 if (!empty($profile['followers']) && ($profile['type'] == 'Group')) {
593 $data['cc'][] = $profile['followers'];
596 $data['to'][] = $profile['url'];
601 if ($is_forum && !$exclusive && !empty($follower)) {
602 $data['cc'][] = $follower;
603 } elseif (!$exclusive) {
604 foreach ($receiver_list as $receiver) {
605 $contact = DBA::selectFirst('contact', ['url', 'hidden', 'network', 'protocol', 'gsid'], ['id' => $receiver, 'network' => Protocol::FEDERATED]);
606 if (!DBA::isResult($contact) || !self::isAPContact($contact, $networks)) {
610 if (!empty($profile = APContact::getByURL($contact['url'], false))) {
611 if ($contact['hidden'] || $always_bcc) {
612 $data['bcc'][] = $profile['url'];
614 $data['cc'][] = $profile['url'];
621 $is_forum_thread = false;
623 if (!empty($item['parent'])) {
624 $parents = Post::select(['id', 'author-link', 'owner-link', 'causer-link', 'gravity', 'uri', 'post-reason'], ['parent' => $item['parent']], ['order' => ['id']]);
625 while ($parent = Post::fetch($parents)) {
626 if ($parent['gravity'] == GRAVITY_PARENT) {
627 if (($parent['post-reason'] == Item::PR_ANNOUNCEMENT) && !empty($parent['causer-link'])) {
628 $profile = APContact::getByURL($parent['causer-link'], false);
629 $is_forum_thread = ($profile['type'] == 'Group');
632 $profile = APContact::getByURL($parent['owner-link'], false);
633 if (!empty($profile)) {
634 if ($item['gravity'] != GRAVITY_PARENT) {
635 // Comments to forums are directed to the forum
636 // But comments to forums aren't directed to the followers collection
637 // This rule is only valid when the actor isn't the forum.
638 // The forum needs to transmit their content to their followers.
639 if (($profile['type'] == 'Group') && ($profile['url'] != ($actor_profile['url'] ?? ''))) {
640 $data['to'][] = $profile['url'];
642 $data['cc'][] = $profile['url'];
643 if (($item['private'] != Item::PRIVATE) && !empty($actor_profile['followers'])&& !$is_forum_thread) {
644 $data['cc'][] = $actor_profile['followers'];
647 } elseif (!$exclusive && !$is_forum_thread) {
648 // Public thread parent post always are directed to the followers.
649 if ($item['private'] != Item::PRIVATE) {
650 $data['cc'][] = $actor_profile['followers'];
656 // Don't include data from future posts
657 if ($parent['id'] >= $last_id) {
661 $profile = APContact::getByURL($parent['author-link'], false);
662 if (!empty($profile)) {
663 if (($profile['type'] == 'Group') || ($parent['uri'] == $item['thr-parent'])) {
664 $data['to'][] = $profile['url'];
666 $data['cc'][] = $profile['url'];
670 DBA::close($parents);
673 $data['to'] = array_unique($data['to']);
674 $data['cc'] = array_unique($data['cc']);
675 $data['bcc'] = array_unique($data['bcc']);
677 if (($key = array_search($item['author-link'], $data['to'])) !== false) {
678 unset($data['to'][$key]);
681 if (($key = array_search($item['author-link'], $data['cc'])) !== false) {
682 unset($data['cc'][$key]);
685 if (($key = array_search($item['author-link'], $data['bcc'])) !== false) {
686 unset($data['bcc'][$key]);
689 foreach ($data['to'] as $to) {
690 if (($key = array_search($to, $data['cc'])) !== false) {
691 unset($data['cc'][$key]);
694 if (($key = array_search($to, $data['bcc'])) !== false) {
695 unset($data['bcc'][$key]);
699 foreach ($data['cc'] as $cc) {
700 if (($key = array_search($cc, $data['bcc'])) !== false) {
701 unset($data['bcc'][$key]);
705 $receivers = ['to' => array_values($data['to']), 'cc' => array_values($data['cc']), 'bcc' => array_values($data['bcc'])];
708 unset($receivers['bcc']);
711 foreach (['to' => Tag::TO, 'cc' => Tag::CC, 'bcc' => Tag::BCC] as $element => $type) {
712 if (!empty($receivers[$element])) {
713 foreach ($receivers[$element] as $receiver) {
714 if ($receiver == ActivityPub::PUBLIC_COLLECTION) {
715 $name = Receiver::PUBLIC_COLLECTION;
717 $name = trim(parse_url($receiver, PHP_URL_PATH), '/');
719 Tag::store($item['uri-id'], $type, $name, $receiver);
728 * Check if an inbox is archived
730 * @param string $url Inbox url
732 * @return boolean "true" if inbox is archived
734 public static function archivedInbox($url)
736 return DBA::exists('inbox-status', ['url' => $url, 'archive' => true]);
740 * Check if a given contact should be delivered via AP
742 * @param array $contact
743 * @param array $networks
747 private static function isAPContact(array $contact, array $networks)
749 if (in_array($contact['network'], $networks) || ($contact['protocol'] == Protocol::ACTIVITYPUB)) {
753 return GServer::getProtocol($contact['gsid'] ?? 0) == Post\DeliveryData::ACTIVITYPUB;
757 * Fetches a list of inboxes of followers of a given user
759 * @param integer $uid User ID
760 * @param boolean $personal fetch personal inboxes
761 * @param boolean $all_ap Retrieve all AP enabled inboxes
763 * @return array of follower inboxes
764 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
765 * @throws \ImagickException
767 public static function fetchTargetInboxesforUser($uid, $personal = false, bool $all_ap = false)
773 if (!empty($item['uid'])) {
774 $profile = User::getOwnerDataById($item['uid']);
775 if (!empty($profile)) {
776 $isforum = $profile['account-type'] == User::ACCOUNT_TYPE_COMMUNITY;
780 if (DI::config()->get('debug', 'total_ap_delivery') || $all_ap) {
781 // Will be activated in a later step
782 $networks = Protocol::FEDERATED;
784 // For now only send to these contacts:
785 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
788 $condition = ['uid' => $uid, 'archive' => false, 'pending' => false, 'blocked' => false, 'network' => Protocol::FEDERATED];
791 $condition['rel'] = [Contact::FOLLOWER, Contact::FRIEND];
794 $contacts = DBA::select('contact', ['id', 'url', 'network', 'protocol', 'gsid'], $condition);
795 while ($contact = DBA::fetch($contacts)) {
796 if (!self::isAPContact($contact, $networks)) {
800 if ($isforum && ($contact['network'] == Protocol::DFRN)) {
804 if (Network::isUrlBlocked($contact['url'])) {
808 $profile = APContact::getByURL($contact['url'], false);
809 if (!empty($profile)) {
810 if (empty($profile['sharedinbox']) || $personal || Contact::isLocal($contact['url'])) {
811 $target = $profile['inbox'];
813 $target = $profile['sharedinbox'];
815 if (!self::archivedInbox($target)) {
816 $inboxes[$target][] = $contact['id'];
820 DBA::close($contacts);
826 * Fetches an array of inboxes for the given item and user
828 * @param array $item Item array
829 * @param integer $uid User ID
830 * @param boolean $personal fetch personal inboxes
831 * @param integer $last_id Last item id for adding receivers
832 * @return array with inboxes
833 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
834 * @throws \ImagickException
836 public static function fetchTargetInboxes($item, $uid, $personal = false, $last_id = 0)
838 $permissions = self::createPermissionBlockForItem($item, true, $last_id);
839 if (empty($permissions)) {
845 if ($item['gravity'] == GRAVITY_ACTIVITY) {
846 $item_profile = APContact::getByURL($item['author-link'], false);
848 $item_profile = APContact::getByURL($item['owner-link'], false);
851 if (empty($item_profile)) {
855 $profile_uid = User::getIdForURL($item_profile['url']);
857 foreach (['to', 'cc', 'bto', 'bcc'] as $element) {
858 if (empty($permissions[$element])) {
862 $blindcopy = in_array($element, ['bto', 'bcc']);
864 foreach ($permissions[$element] as $receiver) {
865 if (empty($receiver) || Network::isUrlBlocked($receiver)) {
869 if ($item_profile && ($receiver == $item_profile['followers']) && ($uid == $profile_uid)) {
870 $inboxes = array_merge($inboxes, self::fetchTargetInboxesforUser($uid, $personal, self::isAPPost($last_id)));
872 $profile = APContact::getByURL($receiver, false);
873 if (!empty($profile)) {
874 $contact = Contact::getByURLForUser($receiver, $uid, false, ['id']);
876 if (empty($profile['sharedinbox']) || $personal || $blindcopy || Contact::isLocal($receiver)) {
877 $target = $profile['inbox'];
879 $target = $profile['sharedinbox'];
881 if (!self::archivedInbox($target)) {
882 $inboxes[$target][] = $contact['id'] ?? 0;
893 * Creates an array in the structure of the item table for a given mail id
895 * @param integer $mail_id
900 public static function ItemArrayFromMail($mail_id, $use_title = false)
902 $mail = DBA::selectFirst('mail', [], ['id' => $mail_id]);
903 if (!DBA::isResult($mail)) {
907 $reply = DBA::selectFirst('mail', ['uri', 'uri-id', 'from-url'], ['parent-uri' => $mail['parent-uri'], 'reply' => false]);
908 if (!DBA::isResult($reply)) {
912 // Making the post more compatible for Mastodon by:
913 // - Making it a note and not an article (no title)
914 // - Moving the title into the "summary" field that is used as a "content warning"
917 $mail['body'] = '[abstract]' . $mail['title'] . "[/abstract]\n" . $mail['body'];
921 $mail['content-warning'] = '';
922 $mail['author-link'] = $mail['owner-link'] = $mail['from-url'];
923 $mail['owner-id'] = $mail['author-id'];
924 $mail['allow_cid'] = '<'.$mail['contact-id'].'>';
925 $mail['allow_gid'] = '';
926 $mail['deny_cid'] = '';
927 $mail['deny_gid'] = '';
928 $mail['private'] = Item::PRIVATE;
929 $mail['deleted'] = false;
930 $mail['edited'] = $mail['created'];
931 $mail['plink'] = DI::baseUrl() . '/message/' . $mail['id'];
932 $mail['parent-uri'] = $reply['uri'];
933 $mail['parent-uri-id'] = $reply['uri-id'];
934 $mail['parent-author-id'] = Contact::getIdForURL($reply['from-url'], 0, false);
935 $mail['gravity'] = ($mail['reply'] ? GRAVITY_COMMENT: GRAVITY_PARENT);
936 $mail['event-type'] = '';
937 $mail['language'] = '';
944 * Creates an activity array for a given mail id
946 * @param integer $mail_id
947 * @param boolean $object_mode Is the activity item is used inside another object?
949 * @return array of activity
952 public static function createActivityFromMail($mail_id, $object_mode = false)
954 $mail = self::ItemArrayFromMail($mail_id);
958 $object = self::createNote($mail);
961 $data = ['@context' => ActivityPub::CONTEXT];
966 $data['id'] = $mail['uri'] . '/Create';
967 $data['type'] = 'Create';
968 $data['actor'] = $mail['author-link'];
969 $data['published'] = DateTimeFormat::utc($mail['created'] . '+00:00', DateTimeFormat::ATOM);
970 $data['instrument'] = self::getService();
971 $data = array_merge($data, self::createPermissionBlockForItem($mail, true));
973 if (empty($data['to']) && !empty($data['cc'])) {
974 $data['to'] = $data['cc'];
977 if (empty($data['to']) && !empty($data['bcc'])) {
978 $data['to'] = $data['bcc'];
984 $object['to'] = $data['to'];
985 $object['tag'] = [['type' => 'Mention', 'href' => $object['to'][0], 'name' => '']];
987 unset($object['cc']);
988 unset($object['bcc']);
990 $data['directMessage'] = true;
992 $data['object'] = $object;
994 $owner = User::getOwnerDataById($mail['uid']);
996 if (!$object_mode && !empty($owner)) {
997 return LDSignature::sign($data, $owner);
1004 * Returns the activity type of a given item
1006 * @param array $item
1008 * @return string with activity type
1009 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1010 * @throws \ImagickException
1012 private static function getTypeOfItem($item)
1016 // Only check for a reshare, if it is a real reshare and no quoted reshare
1017 if (strpos($item['body'], "[share") === 0) {
1018 $announce = self::getAnnounceArray($item);
1019 $reshared = !empty($announce);
1024 } elseif ($item['verb'] == Activity::POST) {
1025 if ($item['created'] == $item['edited']) {
1030 } elseif ($item['verb'] == Activity::LIKE) {
1032 } elseif ($item['verb'] == Activity::DISLIKE) {
1034 } elseif ($item['verb'] == Activity::ATTEND) {
1036 } elseif ($item['verb'] == Activity::ATTENDNO) {
1038 } elseif ($item['verb'] == Activity::ATTENDMAYBE) {
1039 $type = 'TentativeAccept';
1040 } elseif ($item['verb'] == Activity::FOLLOW) {
1042 } elseif ($item['verb'] == Activity::TAG) {
1044 } elseif ($item['verb'] == Activity::ANNOUNCE) {
1054 * Creates the activity or fetches it from the cache
1056 * @param integer $item_id
1057 * @param boolean $force Force new cache entry
1059 * @return array with the activity
1060 * @throws \Exception
1062 public static function createCachedActivityFromItem($item_id, $force = false)
1064 $cachekey = 'APDelivery:createActivity:' . $item_id;
1067 $data = DI::cache()->get($cachekey);
1068 if (!is_null($data)) {
1073 $data = self::createActivityFromItem($item_id);
1075 DI::cache()->set($cachekey, $data, Duration::QUARTER_HOUR);
1080 * Creates an activity array for a given item id
1082 * @param integer $item_id
1083 * @param boolean $object_mode Is the activity item is used inside another object?
1085 * @return false|array
1086 * @throws \Exception
1088 public static function createActivityFromItem(int $item_id, bool $object_mode = false)
1090 Logger::info('Fetching activity', ['item' => $item_id]);
1091 $item = Post::selectFirst(Item::DELIVER_FIELDLIST, ['id' => $item_id, 'parent-network' => Protocol::NATIVE_SUPPORT]);
1092 if (!DBA::isResult($item)) {
1096 if (empty($item['uri-id'])) {
1097 Logger::warning('Item without uri-id', ['item' => $item]);
1101 if (!$item['deleted']) {
1102 $condition = ['item-uri' => $item['uri'], 'protocol' => Conversation::PARCEL_ACTIVITYPUB];
1103 $conversation = DBA::selectFirst('conversation', ['source'], $condition);
1104 if (!$item['origin'] && DBA::isResult($conversation)) {
1105 $data = json_decode($conversation['source'], true);
1106 if (!empty($data['type'])) {
1107 if (in_array($data['type'], ['Create', 'Update'])) {
1109 unset($data['@context']);
1110 unset($data['signature']);
1112 Logger::info('Return stored conversation', ['item' => $item_id]);
1114 } elseif (in_array('as:' . $data['type'], Receiver::CONTENT_TYPES)) {
1115 if (!empty($data['@context'])) {
1116 $context = $data['@context'];
1117 unset($data['@context']);
1119 unset($data['actor']);
1126 $type = self::getTypeOfItem($item);
1128 if (!$object_mode) {
1129 $data = ['@context' => $context ?? ActivityPub::CONTEXT];
1131 if ($item['deleted'] && ($item['gravity'] == GRAVITY_ACTIVITY)) {
1133 } elseif ($item['deleted']) {
1140 if ($type == 'Delete') {
1141 $data['id'] = Item::newURI($item['uid'], $item['guid']) . '/' . $type;;
1142 } elseif (($item['gravity'] == GRAVITY_ACTIVITY) && ($type != 'Undo')) {
1143 $data['id'] = $item['uri'];
1145 $data['id'] = $item['uri'] . '/' . $type;
1148 $data['type'] = $type;
1150 if (($type != 'Announce') || ($item['gravity'] != GRAVITY_PARENT)) {
1151 $data['actor'] = $item['author-link'];
1153 $data['actor'] = $item['owner-link'];
1156 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
1158 $data['instrument'] = self::getService();
1160 $data = array_merge($data, self::createPermissionBlockForItem($item, false));
1162 if (in_array($data['type'], ['Create', 'Update', 'Delete'])) {
1163 $data['object'] = $object ?? self::createNote($item);
1164 } elseif ($data['type'] == 'Add') {
1165 $data = self::createAddTag($item, $data);
1166 } elseif ($data['type'] == 'Announce') {
1167 if ($item['verb'] == ACTIVITY::ANNOUNCE) {
1168 $data['object'] = $item['thr-parent'];
1170 $data = self::createAnnounce($item, $data);
1172 } elseif ($data['type'] == 'Follow') {
1173 $data['object'] = $item['parent-uri'];
1174 } elseif ($data['type'] == 'Undo') {
1175 $data['object'] = self::createActivityFromItem($item_id, true);
1177 $data['diaspora:guid'] = $item['guid'];
1178 if (!empty($item['signed_text'])) {
1179 $data['diaspora:like'] = $item['signed_text'];
1181 $data['object'] = $item['thr-parent'];
1184 if (!empty($item['contact-uid'])) {
1185 $uid = $item['contact-uid'];
1187 $uid = $item['uid'];
1190 $owner = User::getOwnerDataById($uid);
1192 Logger::info('Fetched activity', ['item' => $item_id, 'uid' => $uid]);
1194 // We don't sign if we aren't the actor. This is important for relaying content especially for forums
1195 if (!$object_mode && !empty($owner) && ($data['actor'] == $owner['url'])) {
1196 return LDSignature::sign($data, $owner);
1201 /// @todo Create "conversation" entry
1205 * Creates a location entry for a given item array
1207 * @param array $item
1209 * @return array with location array
1211 private static function createLocation($item)
1213 $location = ['type' => 'Place'];
1215 if (!empty($item['location'])) {
1216 $location['name'] = $item['location'];
1221 if (empty($item['coord'])) {
1222 $coord = Map::getCoordinates($item['location']);
1224 $coords = explode(' ', $item['coord']);
1225 if (count($coords) == 2) {
1226 $coord = ['lat' => $coords[0], 'lon' => $coords[1]];
1230 if (!empty($coord['lat']) && !empty($coord['lon'])) {
1231 $location['latitude'] = $coord['lat'];
1232 $location['longitude'] = $coord['lon'];
1239 * Returns a tag array for a given item array
1241 * @param array $item
1243 * @return array of tags
1244 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1246 private static function createTagList($item)
1250 $terms = Tag::getByURIId($item['uri-id'], [Tag::HASHTAG, Tag::MENTION, Tag::IMPLICIT_MENTION, Tag::EXCLUSIVE_MENTION]);
1251 foreach ($terms as $term) {
1252 if ($term['type'] == Tag::HASHTAG) {
1253 $url = DI::baseUrl() . '/search?tag=' . urlencode($term['name']);
1254 $tags[] = ['type' => 'Hashtag', 'href' => $url, 'name' => '#' . $term['name']];
1256 $contact = Contact::getByURL($term['url'], false, ['addr']);
1257 if (empty($contact)) {
1260 if (!empty($contact['addr'])) {
1261 $mention = '@' . $contact['addr'];
1263 $mention = '@' . $term['url'];
1266 $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
1270 $announce = self::getAnnounceArray($item);
1271 // Mention the original author upon commented reshares
1272 if (!empty($announce['comment'])) {
1273 $tags[] = ['type' => 'Mention', 'href' => $announce['actor']['url'], 'name' => '@' . $announce['actor']['addr']];
1280 * Adds attachment data to the JSON document
1282 * @param array $item Data of the item that is to be posted
1283 * @param string $type Object type
1285 * @return array with attachment data
1286 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1288 private static function createAttachmentList($item, $type)
1292 $uriids = [$item['uri-id']];
1293 $shared = BBCode::fetchShareAttributes($item['body']);
1294 if (!empty($shared['guid'])) {
1295 $shared_item = Post::selectFirst(['uri-id'], ['guid' => $shared['guid']]);
1296 if (!empty($shared_item['uri-id'])) {
1297 $uriids[] = $shared_item['uri-id'];
1302 foreach ($uriids as $uriid) {
1303 foreach (Post\Media::getByURIId($uriid, [Post\Media::AUDIO, Post\Media::IMAGE, Post\Media::VIDEO, Post\Media::DOCUMENT, Post\Media::TORRENT]) as $attachment) {
1304 if (in_array($attachment['url'], $urls)) {
1307 $urls[] = $attachment['url'];
1309 $attach = ['type' => 'Document',
1310 'mediaType' => $attachment['mimetype'],
1311 'url' => $attachment['url'],
1312 'name' => $attachment['description']];
1314 if (!empty($attachment['height'])) {
1315 $attach['height'] = $attachment['height'];
1318 if (!empty($attachment['width'])) {
1319 $attach['width'] = $attachment['width'];
1322 if (!empty($attachment['preview'])) {
1323 $attach['image'] = $attachment['preview'];
1326 $attachments[] = $attach;
1330 return $attachments;
1334 * Callback function to replace a Friendica style mention in a mention for a summary
1336 * @param array $match Matching values for the callback
1337 * @return string Replaced mention
1338 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1340 private static function mentionAddrCallback($match)
1342 if (empty($match[1])) {
1346 $data = Contact::getByURL($match[1], false, ['addr']);
1347 if (empty($data['addr'])) {
1351 return '@' . $data['addr'];
1355 * Remove image elements since they are added as attachment
1357 * @param string $body
1359 * @return string with removed images
1361 private static function removePictures($body)
1363 // Simplify image codes
1364 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
1365 $body = preg_replace("/\[img\=(.*?)\](.*?)\[\/img\]/ism", '[img]$1[/img]', $body);
1367 // Now remove local links
1368 $body = preg_replace_callback(
1369 '/\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]/Usi',
1371 // We remove the link when it is a link to a local photo page
1372 if (Photo::isLocalPage($match[1])) {
1375 // otherwise we just return the link
1376 return '[url]' . $match[1] . '[/url]';
1381 // Remove all pictures
1382 $body = preg_replace("/\[img\]([^\[\]]*)\[\/img\]/Usi", '', $body);
1388 * Fetches the "context" value for a givem item array from the "conversation" table
1390 * @param array $item
1392 * @return string with context url
1393 * @throws \Exception
1395 private static function fetchContextURLForItem($item)
1397 $conversation = DBA::selectFirst('conversation', ['conversation-href', 'conversation-uri'], ['item-uri' => $item['parent-uri']]);
1398 if (DBA::isResult($conversation) && !empty($conversation['conversation-href'])) {
1399 $context_uri = $conversation['conversation-href'];
1400 } elseif (DBA::isResult($conversation) && !empty($conversation['conversation-uri'])) {
1401 $context_uri = $conversation['conversation-uri'];
1403 $context_uri = $item['parent-uri'] . '#context';
1405 return $context_uri;
1409 * Returns if the post contains sensitive content ("nsfw")
1411 * @param integer $uri_id
1414 * @throws \Exception
1416 private static function isSensitive($uri_id)
1418 return DBA::exists('tag-view', ['uri-id' => $uri_id, 'name' => 'nsfw', 'type' => Tag::HASHTAG]);
1422 * Creates event data
1424 * @param array $item
1426 * @return array with the event data
1427 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1429 private static function createEvent($item)
1432 $event['name'] = $item['event-summary'];
1433 $event['content'] = BBCode::convertForUriId($item['uri-id'], $item['event-desc'], BBCode::ACTIVITYPUB);
1434 $event['startTime'] = DateTimeFormat::utc($item['event-start'], 'c');
1436 if (!$item['event-nofinish']) {
1437 $event['endTime'] = DateTimeFormat::utc($item['event-finish'], 'c');
1440 if (!empty($item['event-location'])) {
1441 $item['location'] = $item['event-location'];
1442 $event['location'] = self::createLocation($item);
1445 // 2021.12: Backward compatibility value, all the events now "adjust" to the viewer timezone
1446 $event['dfrn:adjust'] = true;
1452 * Creates a note/article object array
1454 * @param array $item
1456 * @return array with the object data
1457 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1458 * @throws \ImagickException
1460 public static function createNote($item)
1466 if ($item['event-type'] == 'event') {
1468 } elseif (!empty($item['title'])) {
1474 if ($item['deleted']) {
1475 $type = 'Tombstone';
1479 $data['id'] = $item['uri'];
1480 $data['type'] = $type;
1482 if ($item['deleted']) {
1486 $data['summary'] = BBCode::toPlaintext(BBCode::getAbstract($item['body'], Protocol::ACTIVITYPUB));
1488 if ($item['uri'] != $item['thr-parent']) {
1489 $data['inReplyTo'] = $item['thr-parent'];
1491 $data['inReplyTo'] = null;
1494 $data['diaspora:guid'] = $item['guid'];
1495 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
1497 if ($item['created'] != $item['edited']) {
1498 $data['updated'] = DateTimeFormat::utc($item['edited'] . '+00:00', DateTimeFormat::ATOM);
1501 $data['url'] = $item['plink'];
1502 $data['attributedTo'] = $item['author-link'];
1503 $data['sensitive'] = self::isSensitive($item['uri-id']);
1504 $data['context'] = self::fetchContextURLForItem($item);
1506 if (!empty($item['title'])) {
1507 $data['name'] = BBCode::toPlaintext($item['title'], false);
1510 $permission_block = self::createPermissionBlockForItem($item, false);
1512 $body = $item['body'];
1514 if ($type == 'Note') {
1515 $body = $item['raw-body'] ?? self::removePictures($body);
1519 * @todo Improve the automated summary
1520 * This part is currently deactivated. The automated summary seems to be more
1521 * confusing than helping. But possibly we will find a better way.
1522 * So the code is left here for now as a reminder
1524 * } elseif (($type == 'Article') && empty($data['summary'])) {
1525 * $regexp = "/[@!]\[url\=([^\[\]]*)\].*?\[\/url\]/ism";
1526 * $summary = preg_replace_callback($regexp, ['self', 'mentionAddrCallback'], $body);
1527 * $data['summary'] = BBCode::toPlaintext(Plaintext::shorten(self::removePictures($summary), 1000));
1531 if (empty($item['uid']) || !Feature::isEnabled($item['uid'], 'explicit_mentions')) {
1532 $body = self::prependMentions($body, $item['uri-id'], $item['author-link']);
1535 if ($type == 'Event') {
1536 $data = array_merge($data, self::createEvent($item));
1538 $body = BBCode::setMentionsToNicknames($body);
1540 $data['content'] = BBCode::convertForUriId($item['uri-id'], $body, BBCode::ACTIVITYPUB);
1543 // The regular "content" field does contain a minimized HTML. This is done since systems like
1544 // Mastodon has got problems with - for example - embedded pictures.
1545 // The contentMap does contain the unmodified HTML.
1546 $language = self::getLanguage($item);
1547 if (!empty($language)) {
1548 $richbody = BBCode::setMentionsToNicknames($item['body'] ?? '');
1549 $richbody = BBCode::removeAttachment($richbody);
1551 $data['contentMap'][$language] = BBCode::convertForUriId($item['uri-id'], $richbody, BBCode::EXTERNAL);
1554 $data['source'] = ['content' => $item['body'], 'mediaType' => "text/bbcode"];
1556 if (!empty($item['signed_text']) && ($item['uri'] != $item['thr-parent'])) {
1557 $data['diaspora:comment'] = $item['signed_text'];
1560 $data['attachment'] = self::createAttachmentList($item, $type);
1561 $data['tag'] = self::createTagList($item);
1563 if (empty($data['location']) && (!empty($item['coord']) || !empty($item['location']))) {
1564 $data['location'] = self::createLocation($item);
1567 if (!empty($item['app'])) {
1568 $data['generator'] = ['type' => 'Application', 'name' => $item['app']];
1571 $data = array_merge($data, $permission_block);
1577 * Fetches the language from the post, the user or the system.
1579 * @param array $item
1581 * @return string language string
1583 private static function getLanguage(array $item)
1585 // Try to fetch the language from the post itself
1586 if (!empty($item['language'])) {
1587 $languages = array_keys(json_decode($item['language'], true));
1588 if (!empty($languages[0])) {
1589 return $languages[0];
1593 // Otherwise use the user's language
1594 if (!empty($item['uid'])) {
1595 $user = DBA::selectFirst('user', ['language'], ['uid' => $item['uid']]);
1596 if (!empty($user['language'])) {
1597 return $user['language'];
1601 // And finally just use the system language
1602 return DI::config()->get('system', 'language');
1606 * Creates an an "add tag" entry
1608 * @param array $item
1609 * @param array $data activity data
1611 * @return array with activity data for adding tags
1612 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1613 * @throws \ImagickException
1615 private static function createAddTag($item, $data)
1617 $object = XML::parseString($item['object']);
1618 $target = XML::parseString($item["target"]);
1620 $data['diaspora:guid'] = $item['guid'];
1621 $data['actor'] = $item['author-link'];
1622 $data['target'] = (string)$target->id;
1623 $data['summary'] = BBCode::toPlaintext($item['body']);
1624 $data['object'] = ['id' => (string)$object->id, 'type' => 'tag', 'name' => (string)$object->title, 'content' => (string)$object->content];
1630 * Creates an announce object entry
1632 * @param array $item
1633 * @param array $data activity data
1635 * @return array with activity data
1636 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1637 * @throws \ImagickException
1639 private static function createAnnounce($item, $data)
1641 $orig_body = $item['body'];
1642 $announce = self::getAnnounceArray($item);
1643 if (empty($announce)) {
1644 $data['type'] = 'Create';
1645 $data['object'] = self::createNote($item);
1649 if (empty($announce['comment'])) {
1650 // Pure announce, without a quote
1651 $data['type'] = 'Announce';
1652 $data['object'] = $announce['object']['uri'];
1657 $data['type'] = 'Create';
1658 $item['body'] = $announce['comment'] . "\n" . $announce['object']['plink'];
1659 $data['object'] = self::createNote($item);
1661 /// @todo Finally descide how to implement this in AP. This is a possible way:
1662 $data['object']['attachment'][] = self::createNote($announce['object']);
1664 $data['object']['source']['content'] = $orig_body;
1669 * Return announce related data if the item is an annunce
1671 * @param array $item
1675 public static function getAnnounceArray($item)
1677 $reshared = Item::getShareArray($item);
1678 if (empty($reshared['guid'])) {
1682 $reshared_item = Post::selectFirst(Item::DELIVER_FIELDLIST, ['guid' => $reshared['guid']]);
1683 if (!DBA::isResult($reshared_item)) {
1687 if (!in_array($reshared_item['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
1691 $profile = APContact::getByURL($reshared_item['author-link'], false);
1692 if (empty($profile)) {
1696 return ['object' => $reshared_item, 'actor' => $profile, 'comment' => $reshared['comment']];
1700 * Checks if the provided item array is an announce
1702 * @param array $item
1706 public static function isAnnounce($item)
1708 if (!empty($item['verb']) && ($item['verb'] == Activity::ANNOUNCE)) {
1712 $announce = self::getAnnounceArray($item);
1713 if (empty($announce)) {
1717 return empty($announce['comment']);
1721 * Creates an activity id for a given contact id
1723 * @param integer $cid Contact ID of target
1725 * @return bool|string activity id
1727 public static function activityIDFromContact($cid)
1729 $contact = DBA::selectFirst('contact', ['uid', 'id', 'created'], ['id' => $cid]);
1730 if (!DBA::isResult($contact)) {
1734 $hash = hash('ripemd128', $contact['uid'].'-'.$contact['id'].'-'.$contact['created']);
1735 $uuid = substr($hash, 0, 8). '-' . substr($hash, 8, 4) . '-' . substr($hash, 12, 4) . '-' . substr($hash, 16, 4) . '-' . substr($hash, 20, 12);
1736 return DI::baseUrl() . '/activity/' . $uuid;
1740 * Transmits a contact suggestion to a given inbox
1742 * @param integer $uid User ID
1743 * @param string $inbox Target inbox
1744 * @param integer $suggestion_id Suggestion ID
1746 * @return boolean was the transmission successful?
1747 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1749 public static function sendContactSuggestion($uid, $inbox, $suggestion_id)
1751 $owner = User::getOwnerDataById($uid);
1753 $suggestion = DI::fsuggest()->selectOneById($suggestion_id);
1755 $data = ['@context' => ActivityPub::CONTEXT,
1756 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1757 'type' => 'Announce',
1758 'actor' => $owner['url'],
1759 'object' => $suggestion->url,
1760 'content' => $suggestion->note,
1761 'instrument' => self::getService(),
1762 'to' => [ActivityPub::PUBLIC_COLLECTION],
1765 $signed = LDSignature::sign($data, $owner);
1767 Logger::info('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub');
1768 return HTTPSignature::transmit($signed, $inbox, $uid);
1772 * Transmits a profile relocation to a given inbox
1774 * @param integer $uid User ID
1775 * @param string $inbox Target inbox
1777 * @return boolean was the transmission successful?
1778 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1780 public static function sendProfileRelocation($uid, $inbox)
1782 $owner = User::getOwnerDataById($uid);
1784 $data = ['@context' => ActivityPub::CONTEXT,
1785 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1786 'type' => 'dfrn:relocate',
1787 'actor' => $owner['url'],
1788 'object' => $owner['url'],
1789 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1790 'instrument' => self::getService(),
1791 'to' => [ActivityPub::PUBLIC_COLLECTION],
1794 $signed = LDSignature::sign($data, $owner);
1796 Logger::info('Deliver profile relocation for user ' . $uid . ' to ' . $inbox . ' via ActivityPub');
1797 return HTTPSignature::transmit($signed, $inbox, $uid);
1801 * Transmits a profile deletion to a given inbox
1803 * @param integer $uid User ID
1804 * @param string $inbox Target inbox
1806 * @return boolean was the transmission successful?
1807 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1809 public static function sendProfileDeletion($uid, $inbox)
1811 $owner = User::getOwnerDataById($uid);
1813 if (empty($owner)) {
1814 Logger::error('No owner data found, the deletion message cannot be processed.', ['user' => $uid]);
1818 if (empty($owner['uprvkey'])) {
1819 Logger::error('No private key for owner found, the deletion message cannot be processed.', ['user' => $uid]);
1823 $data = ['@context' => ActivityPub::CONTEXT,
1824 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1826 'actor' => $owner['url'],
1827 'object' => $owner['url'],
1828 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1829 'instrument' => self::getService(),
1830 'to' => [ActivityPub::PUBLIC_COLLECTION],
1833 $signed = LDSignature::sign($data, $owner);
1835 Logger::info('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub');
1836 return HTTPSignature::transmit($signed, $inbox, $uid);
1840 * Transmits a profile change to a given inbox
1842 * @param integer $uid User ID
1843 * @param string $inbox Target inbox
1845 * @return boolean was the transmission successful?
1846 * @throws HTTPException\InternalServerErrorException
1847 * @throws HTTPException\NotFoundException
1848 * @throws \ImagickException
1850 public static function sendProfileUpdate(int $uid, string $inbox): bool
1852 $owner = User::getOwnerDataById($uid);
1853 $profile = APContact::getByURL($owner['url']);
1855 $data = ['@context' => ActivityPub::CONTEXT,
1856 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1858 'actor' => $owner['url'],
1859 'object' => self::getProfile($uid),
1860 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1861 'instrument' => self::getService(),
1862 'to' => [$profile['followers']],
1865 $signed = LDSignature::sign($data, $owner);
1867 Logger::info('Deliver profile update for user ' . $uid . ' to ' . $inbox . ' via ActivityPub');
1868 return HTTPSignature::transmit($signed, $inbox, $uid);
1872 * Transmits a given activity to a target
1874 * @param string $activity Type name
1875 * @param string $target Target profile
1876 * @param integer $uid User ID
1878 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1879 * @throws \ImagickException
1880 * @throws \Exception
1882 public static function sendActivity($activity, $target, $uid, $id = '')
1884 $profile = APContact::getByURL($target);
1885 if (empty($profile['inbox'])) {
1886 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
1890 $owner = User::getOwnerDataById($uid);
1893 $id = DI::baseUrl() . '/activity/' . System::createGUID();
1896 $data = ['@context' => ActivityPub::CONTEXT,
1898 'type' => $activity,
1899 'actor' => $owner['url'],
1900 'object' => $profile['url'],
1901 'instrument' => self::getService(),
1902 'to' => [$profile['url']]];
1904 Logger::info('Sending activity ' . $activity . ' to ' . $target . ' for user ' . $uid);
1906 $signed = LDSignature::sign($data, $owner);
1907 return HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1911 * Transmits a "follow object" activity to a target
1912 * This is a preparation for sending automated "follow" requests when receiving "Announce" messages
1914 * @param string $object Object URL
1915 * @param string $target Target profile
1916 * @param integer $uid User ID
1918 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1919 * @throws \ImagickException
1920 * @throws \Exception
1922 public static function sendFollowObject($object, $target, $uid = 0)
1924 $profile = APContact::getByURL($target);
1925 if (empty($profile['inbox'])) {
1926 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
1931 // Fetch the list of administrators
1932 $admin_mail = explode(',', str_replace(' ', '', DI::config()->get('config', 'admin_email')));
1934 // We need to use some user as a sender. It doesn't care who it will send. We will use an administrator account.
1935 $condition = ['verified' => true, 'blocked' => false, 'account_removed' => false, 'account_expired' => false, 'email' => $admin_mail];
1936 $first_user = DBA::selectFirst('user', ['uid'], $condition);
1937 $uid = $first_user['uid'];
1940 $condition = ['verb' => Activity::FOLLOW, 'uid' => 0, 'parent-uri' => $object,
1941 'author-id' => Contact::getPublicIdByUserId($uid)];
1942 if (Post::exists($condition)) {
1943 Logger::info('Follow for ' . $object . ' for user ' . $uid . ' does already exist.');
1947 $owner = User::getOwnerDataById($uid);
1949 $data = ['@context' => ActivityPub::CONTEXT,
1950 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1952 'actor' => $owner['url'],
1953 'object' => $object,
1954 'instrument' => self::getService(),
1955 'to' => [$profile['url']]];
1957 Logger::info('Sending follow ' . $object . ' to ' . $target . ' for user ' . $uid);
1959 $signed = LDSignature::sign($data, $owner);
1960 return HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1964 * Transmit a message that the contact request had been accepted
1966 * @param string $target Target profile
1968 * @param integer $uid User ID
1969 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
1970 * @throws \ImagickException
1972 public static function sendContactAccept($target, $id, $uid)
1974 $profile = APContact::getByURL($target);
1975 if (empty($profile['inbox'])) {
1976 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
1980 $owner = User::getOwnerDataById($uid);
1981 $data = ['@context' => ActivityPub::CONTEXT,
1982 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
1984 'actor' => $owner['url'],
1986 'id' => (string)$id,
1988 'actor' => $profile['url'],
1989 'object' => $owner['url']
1991 'instrument' => self::getService(),
1992 'to' => [$profile['url']]];
1994 Logger::debug('Sending accept to ' . $target . ' for user ' . $uid . ' with id ' . $id);
1996 $signed = LDSignature::sign($data, $owner);
1997 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
2001 * Reject a contact request or terminates the contact relation
2003 * @param string $target Target profile
2005 * @param integer $uid User ID
2006 * @return bool Operation success
2007 * @throws HTTPException\InternalServerErrorException
2008 * @throws \ImagickException
2010 public static function sendContactReject($target, $id, $uid): bool
2012 $profile = APContact::getByURL($target);
2013 if (empty($profile['inbox'])) {
2014 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2018 $owner = User::getOwnerDataById($uid);
2019 $data = ['@context' => ActivityPub::CONTEXT,
2020 'id' => DI::baseUrl() . '/activity/' . System::createGUID(),
2022 'actor' => $owner['url'],
2024 'id' => (string)$id,
2026 'actor' => $profile['url'],
2027 'object' => $owner['url']
2029 'instrument' => self::getService(),
2030 'to' => [$profile['url']]];
2032 Logger::debug('Sending reject to ' . $target . ' for user ' . $uid . ' with id ' . $id);
2034 $signed = LDSignature::sign($data, $owner);
2035 return HTTPSignature::transmit($signed, $profile['inbox'], $uid);
2039 * Transmits a message that we don't want to follow this contact anymore
2041 * @param string $target Target profile
2042 * @param integer $uid User ID
2043 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
2044 * @throws \ImagickException
2045 * @throws \Exception
2046 * @return bool success
2048 public static function sendContactUndo($target, $cid, $uid)
2050 $profile = APContact::getByURL($target);
2051 if (empty($profile['inbox'])) {
2052 Logger::warning('No inbox found for target', ['target' => $target, 'profile' => $profile]);
2056 $object_id = self::activityIDFromContact($cid);
2057 if (empty($object_id)) {
2061 $id = DI::baseUrl() . '/activity/' . System::createGUID();
2063 $owner = User::getOwnerDataById($uid);
2064 $data = ['@context' => ActivityPub::CONTEXT,
2067 'actor' => $owner['url'],
2068 'object' => ['id' => $object_id, 'type' => 'Follow',
2069 'actor' => $owner['url'],
2070 'object' => $profile['url']],
2071 'instrument' => self::getService(),
2072 'to' => [$profile['url']]];
2074 Logger::info('Sending undo to ' . $target . ' for user ' . $uid . ' with id ' . $id);
2076 $signed = LDSignature::sign($data, $owner);
2077 return HTTPSignature::transmit($signed, $profile['inbox'], $uid);
2080 private static function prependMentions($body, int $uriid, string $authorLink)
2084 foreach (Tag::getByURIId($uriid, [Tag::IMPLICIT_MENTION]) as $tag) {
2085 $profile = Contact::getByURL($tag['url'], false, ['addr', 'contact-type', 'nick']);
2086 if (!empty($profile['addr'])
2087 && $profile['contact-type'] != Contact::TYPE_COMMUNITY
2088 && !strstr($body, $profile['addr'])
2089 && !strstr($body, $tag['url'])
2090 && $tag['url'] !== $authorLink
2092 $mentions[] = '@[url=' . $tag['url'] . ']' . $profile['nick'] . '[/url]';
2096 $mentions[] = $body;
2098 return implode(' ', $mentions);