3 * @file src/Protocol/ActivityPub/Transmitter.php
5 namespace Friendica\Protocol\ActivityPub;
7 use Friendica\BaseObject;
8 use Friendica\Database\DBA;
9 use Friendica\Core\Logger;
10 use Friendica\Core\System;
11 use Friendica\Util\HTTPSignature;
12 use Friendica\Core\Protocol;
13 use Friendica\Model\Conversation;
14 use Friendica\Model\Contact;
15 use Friendica\Model\APContact;
16 use Friendica\Model\Item;
17 use Friendica\Model\Term;
18 use Friendica\Model\User;
19 use Friendica\Util\DateTimeFormat;
20 use Friendica\Content\Text\BBCode;
21 use Friendica\Util\JsonLD;
22 use Friendica\Util\LDSignature;
23 use Friendica\Model\Profile;
24 use Friendica\Core\Config;
25 use Friendica\Object\Image;
26 use Friendica\Protocol\ActivityPub;
27 use Friendica\Protocol\Diaspora;
28 use Friendica\Core\Cache;
29 use Friendica\Util\Map;
30 use Friendica\Util\Network;
32 require_once 'include/api.php';
35 * @brief ActivityPub Transmitter Protocol class
43 * collects the lost of followers of the given owner
45 * @param array $owner Owner array
46 * @param integer $page Page number
48 * @return array of owners
50 public static function getFollowers($owner, $page = null)
52 $condition = ['rel' => [Contact::FOLLOWER, Contact::FRIEND], 'network' => Protocol::NATIVE_SUPPORT, 'uid' => $owner['uid'],
53 'self' => false, 'deleted' => false, 'hidden' => false, 'archive' => false, 'pending' => false];
54 $count = DBA::count('contact', $condition);
56 $data = ['@context' => ActivityPub::CONTEXT];
57 $data['id'] = System::baseUrl() . '/followers/' . $owner['nickname'];
58 $data['type'] = 'OrderedCollection';
59 $data['totalItems'] = $count;
61 // When we hide our friends we will only show the pure number but don't allow more.
62 $profile = Profile::getByUID($owner['uid']);
63 if (!empty($profile['hide-friends'])) {
68 $data['first'] = System::baseUrl() . '/followers/' . $owner['nickname'] . '?page=1';
72 $contacts = DBA::select('contact', ['url'], $condition, ['limit' => [($page - 1) * 100, 100]]);
73 while ($contact = DBA::fetch($contacts)) {
74 $list[] = $contact['url'];
78 $data['next'] = System::baseUrl() . '/followers/' . $owner['nickname'] . '?page=' . ($page + 1);
81 $data['partOf'] = System::baseUrl() . '/followers/' . $owner['nickname'];
83 $data['orderedItems'] = $list;
90 * Create list of following contacts
92 * @param array $owner Owner array
93 * @param integer $page Page numbe
95 * @return array of following contacts
97 public static function getFollowing($owner, $page = null)
99 $condition = ['rel' => [Contact::SHARING, Contact::FRIEND], 'network' => Protocol::NATIVE_SUPPORT, 'uid' => $owner['uid'],
100 'self' => false, 'deleted' => false, 'hidden' => false, 'archive' => false, 'pending' => false];
101 $count = DBA::count('contact', $condition);
103 $data = ['@context' => ActivityPub::CONTEXT];
104 $data['id'] = System::baseUrl() . '/following/' . $owner['nickname'];
105 $data['type'] = 'OrderedCollection';
106 $data['totalItems'] = $count;
108 // When we hide our friends we will only show the pure number but don't allow more.
109 $profile = Profile::getByUID($owner['uid']);
110 if (!empty($profile['hide-friends'])) {
115 $data['first'] = System::baseUrl() . '/following/' . $owner['nickname'] . '?page=1';
119 $contacts = DBA::select('contact', ['url'], $condition, ['limit' => [($page - 1) * 100, 100]]);
120 while ($contact = DBA::fetch($contacts)) {
121 $list[] = $contact['url'];
125 $data['next'] = System::baseUrl() . '/following/' . $owner['nickname'] . '?page=' . ($page + 1);
128 $data['partOf'] = System::baseUrl() . '/following/' . $owner['nickname'];
130 $data['orderedItems'] = $list;
137 * Public posts for the given owner
139 * @param array $owner Owner array
140 * @param integer $page Page numbe
142 * @return array of posts
144 public static function getOutbox($owner, $page = null)
146 $public_contact = Contact::getIdForURL($owner['url'], 0, true);
148 $condition = ['uid' => 0, 'contact-id' => $public_contact, 'author-id' => $public_contact,
149 'private' => false, 'gravity' => [GRAVITY_PARENT, GRAVITY_COMMENT],
150 'deleted' => false, 'visible' => true];
151 $count = DBA::count('item', $condition);
153 $data = ['@context' => ActivityPub::CONTEXT];
154 $data['id'] = System::baseUrl() . '/outbox/' . $owner['nickname'];
155 $data['type'] = 'OrderedCollection';
156 $data['totalItems'] = $count;
159 $data['first'] = System::baseUrl() . '/outbox/' . $owner['nickname'] . '?page=1';
163 $condition['parent-network'] = Protocol::NATIVE_SUPPORT;
165 $items = Item::select(['id'], $condition, ['limit' => [($page - 1) * 20, 20], 'order' => ['created' => true]]);
166 while ($item = Item::fetch($items)) {
167 $object = self::createObjectFromItemID($item['id']);
168 unset($object['@context']);
173 $data['next'] = System::baseUrl() . '/outbox/' . $owner['nickname'] . '?page=' . ($page + 1);
176 $data['partOf'] = System::baseUrl() . '/outbox/' . $owner['nickname'];
178 $data['orderedItems'] = $list;
185 * Return the ActivityPub profile of the given user
187 * @param integer $uid User ID
188 * @return array with profile data
190 public static function getProfile($uid)
192 $condition = ['uid' => $uid, 'blocked' => false, 'account_expired' => false,
193 'account_removed' => false, 'verified' => true];
194 $fields = ['guid', 'nickname', 'pubkey', 'account-type', 'page-flags'];
195 $user = DBA::selectFirst('user', $fields, $condition);
196 if (!DBA::isResult($user)) {
200 $fields = ['locality', 'region', 'country-name'];
201 $profile = DBA::selectFirst('profile', $fields, ['uid' => $uid, 'is-default' => true]);
202 if (!DBA::isResult($profile)) {
206 $fields = ['name', 'url', 'location', 'about', 'avatar', 'photo'];
207 $contact = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
208 if (!DBA::isResult($contact)) {
212 // On old installations and never changed contacts this might not be filled
213 if (empty($contact['avatar'])) {
214 $contact['avatar'] = $contact['photo'];
217 $data = ['@context' => ActivityPub::CONTEXT];
218 $data['id'] = $contact['url'];
219 $data['diaspora:guid'] = $user['guid'];
220 $data['type'] = ActivityPub::ACCOUNT_TYPES[$user['account-type']];
221 $data['following'] = System::baseUrl() . '/following/' . $user['nickname'];
222 $data['followers'] = System::baseUrl() . '/followers/' . $user['nickname'];
223 $data['inbox'] = System::baseUrl() . '/inbox/' . $user['nickname'];
224 $data['outbox'] = System::baseUrl() . '/outbox/' . $user['nickname'];
225 $data['preferredUsername'] = $user['nickname'];
226 $data['name'] = $contact['name'];
227 $data['vcard:hasAddress'] = ['@type' => 'vcard:Home', 'vcard:country-name' => $profile['country-name'],
228 'vcard:region' => $profile['region'], 'vcard:locality' => $profile['locality']];
229 $data['summary'] = $contact['about'];
230 $data['url'] = $contact['url'];
231 $data['manuallyApprovesFollowers'] = in_array($user['page-flags'], [Contact::PAGE_NORMAL, Contact::PAGE_PRVGROUP]);
232 $data['publicKey'] = ['id' => $contact['url'] . '#main-key',
233 'owner' => $contact['url'],
234 'publicKeyPem' => $user['pubkey']];
235 $data['endpoints'] = ['sharedInbox' => System::baseUrl() . '/inbox'];
236 $data['icon'] = ['type' => 'Image',
237 'url' => $contact['avatar']];
239 // tags: https://kitty.town/@inmysocks/100656097926961126.json
244 * Returns an array with permissions of a given item array
248 * @return array with permissions
250 private static function fetchPermissionBlockFromConversation($item)
252 if (empty($item['thr-parent'])) {
256 $condition = ['item-uri' => $item['thr-parent'], 'protocol' => Conversation::PARCEL_ACTIVITYPUB];
257 $conversation = DBA::selectFirst('conversation', ['source'], $condition);
258 if (!DBA::isResult($conversation)) {
262 $activity = json_decode($conversation['source'], true);
264 $actor = JsonLD::fetchElement($activity, 'actor', 'id');
265 $profile = APContact::getByURL($actor);
267 $item_profile = APContact::getByURL($item['author-link']);
268 $exclude[] = $item['author-link'];
270 if ($item['gravity'] == GRAVITY_PARENT) {
271 $exclude[] = $item['owner-link'];
274 $permissions['to'][] = $actor;
276 foreach (['to', 'cc', 'bto', 'bcc'] as $element) {
277 if (empty($activity[$element])) {
280 if (is_string($activity[$element])) {
281 $activity[$element] = [$activity[$element]];
284 foreach ($activity[$element] as $receiver) {
285 if ($receiver == $profile['followers'] && !empty($item_profile['followers'])) {
286 $permissions[$element][] = $item_profile['followers'];
287 } elseif (!in_array($receiver, $exclude)) {
288 $permissions[$element][] = $receiver;
296 * Creates an array of permissions from an item thread
299 * @param boolean $blindcopy
300 * @param boolean $last_id
302 * @return array with permission data
304 private static function createPermissionBlockForItem($item, $blindcopy, $last_id = 0)
307 $last_id = $item['id'];
312 // Check if we should always deliver our stuff via BCC
313 if (!empty($item['uid'])) {
314 $profile = Profile::getByUID($item['uid']);
315 if (!empty($profile)) {
316 $always_bcc = $profile['hide-friends'];
320 // Will be activated in a later step
321 // $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS];
323 // For now only send to these contacts:
324 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
326 $data = ['to' => [], 'cc' => [], 'bcc' => []];
328 $actor_profile = APContact::getByURL($item['author-link']);
330 $terms = Term::tagArrayFromItemId($item['id'], TERM_MENTION);
332 if (!$item['private']) {
333 $data = array_merge($data, self::fetchPermissionBlockFromConversation($item));
335 $data['to'][] = ActivityPub::PUBLIC_COLLECTION;
336 if (!empty($actor_profile['followers'])) {
337 $data['cc'][] = $actor_profile['followers'];
340 foreach ($terms as $term) {
341 $profile = APContact::getByURL($term['url'], false);
342 if (!empty($profile)) {
343 $data['to'][] = $profile['url'];
347 $receiver_list = Item::enumeratePermissions($item);
351 foreach ($terms as $term) {
352 $cid = Contact::getIdForURL($term['url'], $item['uid']);
353 if (!empty($cid) && in_array($cid, $receiver_list)) {
354 $contact = DBA::selectFirst('contact', ['url'], ['id' => $cid, 'network' => $networks]);
355 if (DBA::isResult($contact) && !empty($profile = APContact::getByURL($contact['url'], false))) {
356 $data['to'][] = $profile['url'];
361 foreach ($receiver_list as $receiver) {
362 $contact = DBA::selectFirst('contact', ['url', 'hidden'], ['id' => $receiver, 'network' => $networks]);
363 if (DBA::isResult($contact) && !empty($profile = APContact::getByURL($contact['url'], false))) {
364 if ($contact['hidden'] || $always_bcc) {
365 $data['bcc'][] = $profile['url'];
367 $data['cc'][] = $profile['url'];
373 $parents = Item::select(['id', 'author-link', 'owner-link', 'gravity', 'uri'], ['parent' => $item['parent']]);
374 while ($parent = Item::fetch($parents)) {
375 // Don't include data from future posts
376 if ($parent['id'] >= $last_id) {
380 $profile = APContact::getByURL($parent['author-link'], false);
381 if (!empty($profile)) {
382 if ($parent['uri'] == $item['thr-parent']) {
383 $data['to'][] = $profile['url'];
385 $data['cc'][] = $profile['url'];
389 if ($item['gravity'] != GRAVITY_PARENT) {
393 $profile = APContact::getByURL($parent['owner-link'], false);
394 if (!empty($profile)) {
395 $data['cc'][] = $profile['url'];
398 DBA::close($parents);
400 $data['to'] = array_unique($data['to']);
401 $data['cc'] = array_unique($data['cc']);
402 $data['bcc'] = array_unique($data['bcc']);
404 if (($key = array_search($item['author-link'], $data['to'])) !== false) {
405 unset($data['to'][$key]);
408 if (($key = array_search($item['author-link'], $data['cc'])) !== false) {
409 unset($data['cc'][$key]);
412 if (($key = array_search($item['author-link'], $data['bcc'])) !== false) {
413 unset($data['bcc'][$key]);
416 foreach ($data['to'] as $to) {
417 if (($key = array_search($to, $data['cc'])) !== false) {
418 unset($data['cc'][$key]);
421 if (($key = array_search($to, $data['bcc'])) !== false) {
422 unset($data['bcc'][$key]);
426 foreach ($data['cc'] as $cc) {
427 if (($key = array_search($cc, $data['bcc'])) !== false) {
428 unset($data['bcc'][$key]);
432 $receivers = ['to' => array_values($data['to']), 'cc' => array_values($data['cc']), 'bcc' => array_values($data['bcc'])];
435 unset($receivers['bcc']);
442 * Fetches a list of inboxes of followers of a given user
444 * @param integer $uid User ID
445 * @param boolean $personal fetch personal inboxes
447 * @return array of follower inboxes
449 public static function fetchTargetInboxesforUser($uid, $personal = false)
453 // Will be activated in a later step
454 // $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS];
456 // For now only send to these contacts:
457 $networks = [Protocol::ACTIVITYPUB, Protocol::OSTATUS];
459 $condition = ['uid' => $uid, 'network' => $networks, 'archive' => false, 'pending' => false];
462 $condition['rel'] = [Contact::FOLLOWER, Contact::FRIEND];
465 $contacts = DBA::select('contact', ['url'], $condition);
466 while ($contact = DBA::fetch($contacts)) {
467 if (Network::isUrlBlocked($contact['url'])) {
471 $profile = APContact::getByURL($contact['url'], false);
472 if (!empty($profile)) {
473 if (empty($profile['sharedinbox']) || $personal) {
474 $target = $profile['inbox'];
476 $target = $profile['sharedinbox'];
478 $inboxes[$target] = $target;
481 DBA::close($contacts);
487 * Fetches an array of inboxes for the given item and user
490 * @param integer $uid User ID
491 * @param boolean $personal fetch personal inboxes
492 * @param integer $last_id Last item id for adding receivers
494 * @return array with inboxes
496 public static function fetchTargetInboxes($item, $uid, $personal = false, $last_id = 0)
498 $permissions = self::createPermissionBlockForItem($item, true, $last_id);
499 if (empty($permissions)) {
505 if ($item['gravity'] == GRAVITY_ACTIVITY) {
506 $item_profile = APContact::getByURL($item['author-link'], false);
508 $item_profile = APContact::getByURL($item['owner-link'], false);
511 foreach (['to', 'cc', 'bto', 'bcc'] as $element) {
512 if (empty($permissions[$element])) {
516 $blindcopy = in_array($element, ['bto', 'bcc']);
518 foreach ($permissions[$element] as $receiver) {
519 if (Network::isUrlBlocked($receiver)) {
523 if ($receiver == $item_profile['followers']) {
524 $inboxes = array_merge($inboxes, self::fetchTargetInboxesforUser($uid, $personal));
526 $profile = APContact::getByURL($receiver, false);
527 if (!empty($profile)) {
528 if (empty($profile['sharedinbox']) || $personal || $blindcopy) {
529 $target = $profile['inbox'];
531 $target = $profile['sharedinbox'];
533 $inboxes[$target] = $target;
543 * Returns the activity type of a given item
547 * @return string with activity type
549 private static function getTypeOfItem($item)
551 if (!empty(Diaspora::isReshare($item['body'], false))) {
553 } elseif ($item['verb'] == ACTIVITY_POST) {
554 if ($item['created'] == $item['edited']) {
559 } elseif ($item['verb'] == ACTIVITY_LIKE) {
561 } elseif ($item['verb'] == ACTIVITY_DISLIKE) {
563 } elseif ($item['verb'] == ACTIVITY_ATTEND) {
565 } elseif ($item['verb'] == ACTIVITY_ATTENDNO) {
567 } elseif ($item['verb'] == ACTIVITY_ATTENDMAYBE) {
568 $type = 'TentativeAccept';
577 * Creates the activity or fetches it from the cache
579 * @param integer $item_id
580 * @param boolean $force Force new cache entry
582 * @return array with the activity
584 public static function createCachedActivityFromItem($item_id, $force = false)
586 $cachekey = 'APDelivery:createActivity:' . $item_id;
589 $data = Cache::get($cachekey);
590 if (!is_null($data)) {
595 $data = ActivityPub\Transmitter::createActivityFromItem($item_id);
597 Cache::set($cachekey, $data, Cache::QUARTER_HOUR);
602 * Creates an activity array for a given item id
604 * @param integer $item_id
605 * @param boolean $object_mode Is the activity item is used inside another object?
607 * @return array of activity
609 public static function createActivityFromItem($item_id, $object_mode = false)
611 $item = Item::selectFirst([], ['id' => $item_id, 'parent-network' => Protocol::NATIVE_SUPPORT]);
613 if (!DBA::isResult($item)) {
617 $condition = ['item-uri' => $item['uri'], 'protocol' => Conversation::PARCEL_ACTIVITYPUB];
618 $conversation = DBA::selectFirst('conversation', ['source'], $condition);
619 if (DBA::isResult($conversation)) {
620 $data = json_decode($conversation['source']);
626 $type = self::getTypeOfItem($item);
629 $data = ['@context' => ActivityPub::CONTEXT];
631 if ($item['deleted'] && ($item['gravity'] == GRAVITY_ACTIVITY)) {
633 } elseif ($item['deleted']) {
640 $data['id'] = $item['uri'] . '#' . $type;
641 $data['type'] = $type;
642 $data['actor'] = $item['owner-link'];
644 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
646 $data['instrument'] = ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()];
648 $data = array_merge($data, self::createPermissionBlockForItem($item, false));
650 if (in_array($data['type'], ['Create', 'Update', 'Delete'])) {
651 $data['object'] = self::createNote($item);
652 } elseif ($data['type'] == 'Announce') {
653 $data['object'] = self::createAnnounce($item);
654 } elseif ($data['type'] == 'Undo') {
655 $data['object'] = self::createActivityFromItem($item_id, true);
657 $data['diaspora:guid'] = $item['guid'];
658 if (!empty($item['signed_text'])) {
659 $data['diaspora:like'] = $item['signed_text'];
661 $data['object'] = $item['thr-parent'];
664 if (!empty($item['contact-uid'])) {
665 $uid = $item['contact-uid'];
670 $owner = User::getOwnerDataById($uid);
672 if (!$object_mode && !empty($owner)) {
673 return LDSignature::sign($data, $owner);
678 /// @todo Create "conversation" entry
682 * Creates an object array for a given item id
684 * @param integer $item_id
686 * @return array with the object data
688 public static function createObjectFromItemID($item_id)
690 $item = Item::selectFirst([], ['id' => $item_id, 'parent-network' => Protocol::NATIVE_SUPPORT]);
692 if (!DBA::isResult($item)) {
696 $data = ['@context' => ActivityPub::CONTEXT];
697 $data = array_merge($data, self::createNote($item));
703 * Creates a location entry for a given item array
707 * @return array with location array
709 private static function createLocation($item)
711 $location = ['type' => 'Place'];
713 if (!empty($item['location'])) {
714 $location['name'] = $item['location'];
719 if (empty($item['coord'])) {
720 $coord = Map::getCoordinates($item['location']);
722 $coords = explode(' ', $item['coord']);
723 if (count($coords) == 2) {
724 $coord = ['lat' => $coords[0], 'lon' => $coords[1]];
728 if (!empty($coord['lat']) && !empty($coord['lon'])) {
729 $location['latitude'] = $coord['lat'];
730 $location['longitude'] = $coord['lon'];
737 * Returns a tag array for a given item array
741 * @return array of tags
743 private static function createTagList($item)
747 $terms = Term::tagArrayFromItemId($item['id']);
748 foreach ($terms as $term) {
749 if ($term['type'] == TERM_HASHTAG) {
750 $tags[] = ['type' => 'Hashtag', 'href' => $term['url'], 'name' => '#' . $term['term']];
751 } elseif ($term['type'] == TERM_MENTION) {
752 $contact = Contact::getDetailsByURL($term['url']);
753 if (!empty($contact['addr'])) {
754 $mention = '@' . $contact['addr'];
756 $mention = '@' . $term['url'];
759 $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
766 * Adds attachment data to the JSON document
768 * @param array $item Data of the item that is to be posted
769 * @param text $type Object type
771 * @return array with attachment data
773 private static function createAttachmentList($item, $type)
777 $arr = explode('[/attach],', $item['attach']);
779 foreach ($arr as $r) {
781 $cnt = preg_match('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|', $r, $matches);
783 $attributes = ['type' => 'Document',
784 'mediaType' => $matches[3],
785 'url' => $matches[1],
788 if (trim($matches[4]) != '') {
789 $attributes['name'] = trim($matches[4]);
792 $attachments[] = $attributes;
797 if ($type != 'Note') {
801 // Simplify image codes
802 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $item['body']);
804 // Grab all pictures and create attachments out of them
805 if (preg_match_all("/\[img\]([^\[\]]*)\[\/img\]/Usi", $body, $pictures)) {
806 foreach ($pictures[1] as $picture) {
807 $imgdata = Image::getInfoFromURL($picture);
809 $attachments[] = ['type' => 'Document',
810 'mediaType' => $imgdata['mime'],
821 * @brief Callback function to replace a Friendica style mention in a mention that is used on AP
823 * @param array $match Matching values for the callback
824 * @return string Replaced mention
826 private static function mentionCallback($match)
828 if (empty($match[1])) {
832 $data = Contact::getDetailsByURL($match[1]);
833 if (empty($data) || empty($data['nick'])) {
837 return '@[url=' . $data['url'] . ']' . $data['nick'] . '[/url]';
841 * Remove image elements and replaces them with links to the image
843 * @param string $body
845 * @return string with replaced elements
847 private static function removePictures($body)
849 // Simplify image codes
850 $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
852 $body = preg_replace("/\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]/Usi", '[url]$1[/url]', $body);
853 $body = preg_replace("/\[img\]([^\[\]]*)\[\/img\]/Usi", '[url]$1[/url]', $body);
859 * Fetches the "context" value for a givem item array from the "conversation" table
863 * @return string with context url
865 private static function fetchContextURLForItem($item)
867 $conversation = DBA::selectFirst('conversation', ['conversation-href', 'conversation-uri'], ['item-uri' => $item['parent-uri']]);
868 if (DBA::isResult($conversation) && !empty($conversation['conversation-href'])) {
869 $context_uri = $conversation['conversation-href'];
870 } elseif (DBA::isResult($conversation) && !empty($conversation['conversation-uri'])) {
871 $context_uri = $conversation['conversation-uri'];
873 $context_uri = $item['parent-uri'] . '#context';
879 * Returns if the post contains sensitive content ("nsfw")
881 * @param integer $item_id
885 private static function isSensitive($item_id)
887 $condition = ['otype' => TERM_OBJ_POST, 'oid' => $item_id, 'type' => TERM_HASHTAG, 'term' => 'nsfw'];
888 return DBA::exists('term', $condition);
896 * @return array with the event data
898 public static function createEvent($item)
901 $event['name'] = $item['event-summary'];
902 $event['content'] = BBCode::convert($item['event-desc'], false, 7);
903 $event['startTime'] = DateTimeFormat::utc($item['event-start'] . '+00:00', DateTimeFormat::ATOM);
905 if (!$item['event-nofinish']) {
906 $event['endTime'] = DateTimeFormat::utc($item['event-finish'] . '+00:00', DateTimeFormat::ATOM);
909 if (!empty($item['event-location'])) {
910 $item['location'] = $item['event-location'];
911 $event['location'] = self::createLocation($item);
918 * Creates a note/article object array
922 * @return array with the object data
924 public static function createNote($item)
926 if ($item['event-type'] == 'event') {
928 } elseif (!empty($item['title'])) {
934 if ($item['deleted']) {
939 $data['id'] = $item['uri'];
940 $data['type'] = $type;
942 if ($item['deleted']) {
946 $data['summary'] = null; // Ignore by now
948 if ($item['uri'] != $item['thr-parent']) {
949 $data['inReplyTo'] = $item['thr-parent'];
951 $data['inReplyTo'] = null;
954 $data['diaspora:guid'] = $item['guid'];
955 $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
957 if ($item['created'] != $item['edited']) {
958 $data['updated'] = DateTimeFormat::utc($item['edited'] . '+00:00', DateTimeFormat::ATOM);
961 $data['url'] = $item['plink'];
962 $data['attributedTo'] = $item['author-link'];
963 $data['sensitive'] = self::isSensitive($item['id']);
964 $data['context'] = self::fetchContextURLForItem($item);
966 if (!empty($item['title'])) {
967 $data['name'] = BBCode::toPlaintext($item['title'], false);
970 $body = $item['body'];
972 if ($type == 'Note') {
973 $body = self::removePictures($body);
976 if ($type == 'Event') {
977 $data = array_merge($data, self::createEvent($item));
979 $regexp = "/[@!]\[url\=([^\[\]]*)\].*?\[\/url\]/ism";
980 $body = preg_replace_callback($regexp, ['self', 'mentionCallback'], $body);
982 $data['content'] = BBCode::convert($body, false, 7);
985 $data['source'] = ['content' => $item['body'], 'mediaType' => "text/bbcode"];
987 if (!empty($item['signed_text']) && ($item['uri'] != $item['thr-parent'])) {
988 $data['diaspora:comment'] = $item['signed_text'];
991 $data['attachment'] = self::createAttachmentList($item, $type);
992 $data['tag'] = self::createTagList($item);
994 if (empty($data['location']) && (!empty($item['coord']) || !empty($item['location']))) {
995 $data['location'] = self::createLocation($item);
998 if (!empty($item['app'])) {
999 $data['generator'] = ['type' => 'Application', 'name' => $item['app']];
1002 $data = array_merge($data, self::createPermissionBlockForItem($item, false));
1008 * Creates an announce object entry
1010 * @param array $item
1012 * @return string with announced object url
1014 public static function createAnnounce($item)
1016 $announce = api_share_as_retweet($item);
1017 if (empty($announce['plink'])) {
1018 return self::createNote($item);
1021 return $announce['plink'];
1025 * Creates an activity id for a given contact id
1027 * @param integer $cid Contact ID of target
1029 * @return bool|string activity id
1031 public static function activityIDFromContact($cid)
1033 $contact = DBA::selectFirst('contact', ['uid', 'id', 'created'], ['id' => $cid]);
1034 if (!DBA::isResult($contact)) {
1038 $hash = hash('ripemd128', $contact['uid'].'-'.$contact['id'].'-'.$contact['created']);
1039 $uuid = substr($hash, 0, 8). '-' . substr($hash, 8, 4) . '-' . substr($hash, 12, 4) . '-' . substr($hash, 16, 4) . '-' . substr($hash, 20, 12);
1040 return System::baseUrl() . '/activity/' . $uuid;
1044 * Transmits a contact suggestion to a given inbox
1046 * @param integer $uid User ID
1047 * @param string $inbox Target inbox
1048 * @param integer $suggestion_id Suggestion ID
1050 * @return boolean was the transmission successful?
1052 public static function sendContactSuggestion($uid, $inbox, $suggestion_id)
1054 $owner = User::getOwnerDataById($uid);
1056 $suggestion = DBA::selectFirst('fsuggest', ['url', 'note', 'created'], ['id' => $suggestion_id]);
1058 $data = ['@context' => ActivityPub::CONTEXT,
1059 'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1060 'type' => 'Announce',
1061 'actor' => $owner['url'],
1062 'object' => $suggestion['url'],
1063 'content' => $suggestion['note'],
1064 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1065 'to' => [ActivityPub::PUBLIC_COLLECTION],
1068 $signed = LDSignature::sign($data, $owner);
1070 Logger::log('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1071 return HTTPSignature::transmit($signed, $inbox, $uid);
1075 * Transmits a profile relocation to a given inbox
1077 * @param integer $uid User ID
1078 * @param string $inbox Target inbox
1080 * @return boolean was the transmission successful?
1082 public static function sendProfileRelocation($uid, $inbox)
1084 $owner = User::getOwnerDataById($uid);
1086 $data = ['@context' => ActivityPub::CONTEXT,
1087 'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1088 'type' => 'dfrn:relocate',
1089 'actor' => $owner['url'],
1090 'object' => $owner['url'],
1091 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1092 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1093 'to' => [ActivityPub::PUBLIC_COLLECTION],
1096 $signed = LDSignature::sign($data, $owner);
1098 Logger::log('Deliver profile relocation for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1099 return HTTPSignature::transmit($signed, $inbox, $uid);
1103 * Transmits a profile deletion to a given inbox
1105 * @param integer $uid User ID
1106 * @param string $inbox Target inbox
1108 * @return boolean was the transmission successful?
1110 public static function sendProfileDeletion($uid, $inbox)
1112 $owner = User::getOwnerDataById($uid);
1114 $data = ['@context' => ActivityPub::CONTEXT,
1115 'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1117 'actor' => $owner['url'],
1118 'object' => $owner['url'],
1119 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1120 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1121 'to' => [ActivityPub::PUBLIC_COLLECTION],
1124 $signed = LDSignature::sign($data, $owner);
1126 Logger::log('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1127 return HTTPSignature::transmit($signed, $inbox, $uid);
1131 * Transmits a profile change to a given inbox
1133 * @param integer $uid User ID
1134 * @param string $inbox Target inbox
1136 * @return boolean was the transmission successful?
1138 public static function sendProfileUpdate($uid, $inbox)
1140 $owner = User::getOwnerDataById($uid);
1141 $profile = APContact::getByURL($owner['url']);
1143 $data = ['@context' => ActivityPub::CONTEXT,
1144 'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1146 'actor' => $owner['url'],
1147 'object' => self::getProfile($uid),
1148 'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
1149 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1150 'to' => [$profile['followers']],
1153 $signed = LDSignature::sign($data, $owner);
1155 Logger::log('Deliver profile update for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', Logger::DEBUG);
1156 return HTTPSignature::transmit($signed, $inbox, $uid);
1160 * Transmits a given activity to a target
1162 * @param array $activity
1163 * @param string $target Target profile
1164 * @param integer $uid User ID
1165 * @param string $id activity id
1167 public static function sendActivity($activity, $target, $uid, $id = '')
1169 $profile = APContact::getByURL($target);
1171 $owner = User::getOwnerDataById($uid);
1174 $id = System::baseUrl() . '/activity/' . System::createGUID();
1177 $data = ['@context' => ActivityPub::CONTEXT,
1179 'type' => $activity,
1180 'actor' => $owner['url'],
1181 'object' => $profile['url'],
1182 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1183 'to' => [$profile['url']]];
1185 Logger::log('Sending activity ' . $activity . ' to ' . $target . ' for user ' . $uid, Logger::DEBUG);
1187 $signed = LDSignature::sign($data, $owner);
1188 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1192 * Transmit a message that the contact request had been accepted
1194 * @param string $target Target profile
1196 * @param integer $uid User ID
1198 public static function sendContactAccept($target, $id, $uid)
1200 $profile = APContact::getByURL($target);
1202 $owner = User::getOwnerDataById($uid);
1203 $data = ['@context' => ActivityPub::CONTEXT,
1204 'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1206 'actor' => $owner['url'],
1207 'object' => ['id' => $id, 'type' => 'Follow',
1208 'actor' => $profile['url'],
1209 'object' => $owner['url']],
1210 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1211 'to' => [$profile['url']]];
1213 Logger::log('Sending accept to ' . $target . ' for user ' . $uid . ' with id ' . $id, Logger::DEBUG);
1215 $signed = LDSignature::sign($data, $owner);
1216 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1220 * Reject a contact request or terminates the contact relation
1222 * @param string $target Target profile
1224 * @param integer $uid User ID
1226 public static function sendContactReject($target, $id, $uid)
1228 $profile = APContact::getByURL($target);
1230 $owner = User::getOwnerDataById($uid);
1231 $data = ['@context' => ActivityPub::CONTEXT,
1232 'id' => System::baseUrl() . '/activity/' . System::createGUID(),
1234 'actor' => $owner['url'],
1235 'object' => ['id' => $id, 'type' => 'Follow',
1236 'actor' => $profile['url'],
1237 'object' => $owner['url']],
1238 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1239 'to' => [$profile['url']]];
1241 Logger::log('Sending reject to ' . $target . ' for user ' . $uid . ' with id ' . $id, Logger::DEBUG);
1243 $signed = LDSignature::sign($data, $owner);
1244 HTTPSignature::transmit($signed, $profile['inbox'], $uid);
1248 * Transmits a message that we don't want to follow this contact anymore
1250 * @param string $target Target profile
1251 * @param integer $cid Contact ID of target
1252 * @param integer $uid User ID
1254 public static function sendContactUndo($target, $cid, $uid)
1256 $profile = APContact::getByURL($target);
1258 $object_id = self::activityIDFromContact($cid);
1259 if (empty($object_id)) {
1263 $id = System::baseUrl() . '/activity/' . System::createGUID();
1265 $owner = User::getOwnerDataById($uid);
1266 $data = ['@context' => ActivityPub::CONTEXT,
1269 'actor' => $owner['url'],
1270 'object' => ['id' => $object_id, 'type' => 'Follow',
1271 'actor' => $owner['url'],
1272 'object' => $profile['url']],
1273 'instrument' => ['type' => 'Service', 'name' => BaseObject::getApp()->getUserAgent()],
1274 'to' => [$profile['url']]];
1276 Logger::log('Sending undo to ' . $target . ' for user ' . $uid . ' with id ' . $id, Logger::DEBUG);
1278 $signed = LDSignature::sign($data, $owner);
1279 HTTPSignature::transmit($signed, $profile['inbox'], $uid);