3 * @file src/Protocol/ActivityPub/Processor.php
5 namespace Friendica\Protocol\ActivityPub;
7 use Friendica\Database\DBA;
8 use Friendica\Content\Text\HTML;
9 use Friendica\Core\Config;
10 use Friendica\Core\Logger;
11 use Friendica\Core\Protocol;
12 use Friendica\Model\Contact;
13 use Friendica\Model\APContact;
14 use Friendica\Model\Item;
15 use Friendica\Model\Event;
16 use Friendica\Model\Term;
17 use Friendica\Model\User;
18 use Friendica\Protocol\ActivityPub;
19 use Friendica\Util\DateTimeFormat;
20 use Friendica\Util\JsonLD;
21 use Friendica\Util\Strings;
24 * ActivityPub Processor Protocol class
29 * Converts mentions from Pleroma into the Friendica format
33 * @return string converted body
35 private static function convertMentions($body)
37 $URLSearchString = "^\[\]";
38 $body = preg_replace("/\[url\=([$URLSearchString]*)\]([#@!])(.*?)\[\/url\]/ism", '$2[url=$1]$3[/url]', $body);
44 * Replaces emojis in the body
46 * @param array $emojis
49 * @return string with replaced emojis
51 public static function replaceEmojis($body, array $emojis)
53 foreach ($emojis as $emoji) {
54 $replace = '[class=emoji mastodon][img=' . $emoji['href'] . ']' . $emoji['name'] . '[/img][/class]';
55 $body = str_replace($emoji['name'], $replace, $body);
61 * Constructs a string with tags for a given tag array
64 * @param boolean $sensitive
65 * @param array $implicit_mentions List of profile URLs to skip
66 * @return string with tags
68 private static function constructTagString(array $tags, $sensitive)
75 foreach ($tags as $tag) {
76 if (in_array(defaults($tag, 'type', ''), ['Mention', 'Hashtag'])) {
77 if (!empty($tag_text)) {
81 $tag_text .= substr($tag['name'], 0, 1) . '[url=' . $tag['href'] . ']' . substr($tag['name'], 1) . '[/url]';
85 /// @todo add nsfw for $sensitive
91 * Add attachment data to the item array
93 * @param array $attachments
98 private static function constructAttachList($attachments, $item)
100 if (empty($attachments)) {
104 foreach ($attachments as $attach) {
105 $filetype = strtolower(substr($attach['mediaType'], 0, strpos($attach['mediaType'], '/')));
106 if ($filetype == 'image') {
107 $item['body'] .= "\n[img]" . $attach['url'] . '[/img]';
109 if (!empty($item["attach"])) {
110 $item["attach"] .= ',';
112 $item["attach"] = '';
114 if (!isset($attach['length'])) {
115 $attach['length'] = "0";
117 $item["attach"] .= '[attach]href="'.$attach['url'].'" length="'.$attach['length'].'" type="'.$attach['mediaType'].'" title="'.defaults($attach, 'name', '').'"[/attach]';
127 * @param array $activity Activity array
128 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
130 public static function updateItem($activity)
132 $item = Item::selectFirst(['uri', 'thr-parent', 'gravity'], ['uri' => $activity['id']]);
133 if (!DBA::isResult($item)) {
134 Logger::warning('Unknown item', ['uri' => $activity['id']]);
138 $item['changed'] = DateTimeFormat::utcNow();
139 $item['edited'] = $activity['updated'];
140 $item['title'] = HTML::toBBCode($activity['name']);
142 if (!empty($activity['source'])) {
143 $content = $activity['source'];
145 $item['content-warning'] = HTML::toBBCode($activity['summary']);
147 $content = HTML::toBBCode($activity['content']);
148 $content = self::replaceEmojis($content, $activity['emojis']);
149 $content = self::convertMentions($content);
151 if (($item['thr-parent'] != $item['uri']) && ($item['gravity'] == GRAVITY_COMMENT)) {
152 $parent = Item::selectFirst(['id', 'author-link', 'alias'], ['uri' => $item['thr-parent']]);
153 if (!DBA::isResult($parent)) {
154 Logger::warning('Unknown parent item.', ['uri' => $item['thr-parent']]);
158 $potential_implicit_mentions = self::getImplicitMentionList($parent);
159 $content = self::removeImplicitMentionsFromBody($content, $potential_implicit_mentions);
160 $activity['tags'] = self::convertImplicitMentionsInTags($activity['tags'], $potential_implicit_mentions);
164 $item['body'] = $content;
165 $item['tag'] = self::constructTagString($activity['tags'], $activity['sensitive']);
167 Item::update($item, ['uri' => $activity['id']]);
171 * Prepares data for a message
173 * @param array $activity Activity array
174 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
175 * @throws \ImagickException
177 public static function createItem($activity)
180 $item['verb'] = ACTIVITY_POST;
181 $item['thr-parent'] = $activity['reply-to-id'];
183 if ($activity['reply-to-id'] == $activity['id']) {
184 $item['gravity'] = GRAVITY_PARENT;
185 $item['object-type'] = ACTIVITY_OBJ_NOTE;
187 $item['gravity'] = GRAVITY_COMMENT;
188 $item['object-type'] = ACTIVITY_OBJ_COMMENT;
191 if (($activity['id'] != $activity['reply-to-id']) && !Item::exists(['uri' => $activity['reply-to-id']])) {
192 Logger::log('Parent ' . $activity['reply-to-id'] . ' not found. Try to refetch it.');
193 self::fetchMissingActivity($activity['reply-to-id'], $activity);
196 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:comment', '');
198 self::postItem($activity, $item);
204 * @param array $activity
205 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
206 * @throws \ImagickException
208 public static function deleteItem($activity)
210 $owner = Contact::getIdForURL($activity['actor']);
212 Logger::log('Deleting item ' . $activity['object_id'] . ' from ' . $owner, Logger::DEBUG);
213 Item::delete(['uri' => $activity['object_id'], 'owner-id' => $owner]);
217 * Prepare the item array for an activity
219 * @param array $activity Activity array
220 * @param string $verb Activity verb
221 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
222 * @throws \ImagickException
224 public static function createActivity($activity, $verb)
227 $item['verb'] = $verb;
228 $item['thr-parent'] = $activity['object_id'];
229 $item['gravity'] = GRAVITY_ACTIVITY;
230 $item['object-type'] = ACTIVITY_OBJ_NOTE;
232 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:like', '');
234 self::postItem($activity, $item);
240 * @param array $activity Activity array
244 public static function createEvent($activity, $item)
246 $event['summary'] = HTML::toBBCode($activity['name']);
247 $event['desc'] = HTML::toBBCode($activity['content']);
248 $event['start'] = $activity['start-time'];
249 $event['finish'] = $activity['end-time'];
250 $event['nofinish'] = empty($event['finish']);
251 $event['location'] = $activity['location'];
252 $event['adjust'] = true;
253 $event['cid'] = $item['contact-id'];
254 $event['uid'] = $item['uid'];
255 $event['uri'] = $item['uri'];
256 $event['edited'] = $item['edited'];
257 $event['private'] = $item['private'];
258 $event['guid'] = $item['guid'];
259 $event['plink'] = $item['plink'];
261 $condition = ['uri' => $item['uri'], 'uid' => $item['uid']];
262 $ev = DBA::selectFirst('event', ['id'], $condition);
263 if (DBA::isResult($ev)) {
264 $event['id'] = $ev['id'];
267 $event_id = Event::store($event);
268 Logger::log('Event '.$event_id.' was stored', Logger::DEBUG);
272 * Creates an item post
274 * @param array $activity Activity data
275 * @param array $item item array
276 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
277 * @throws \ImagickException
279 private static function postItem($activity, $item)
281 /// @todo What to do with $activity['context']?
283 if (($item['gravity'] != GRAVITY_PARENT) && !Item::exists(['uri' => $item['thr-parent']])) {
284 Logger::info('Parent not found, message will be discarded.', ['thr-parent' => $item['thr-parent']]);
288 $item['network'] = Protocol::ACTIVITYPUB;
289 $item['private'] = !in_array(0, $activity['receiver']);
290 $item['author-link'] = $activity['author'];
291 $item['author-id'] = Contact::getIdForURL($activity['author'], 0, true);
293 if (empty($activity['thread-completion'])) {
294 $item['owner-link'] = $activity['actor'];
295 $item['owner-id'] = Contact::getIdForURL($activity['actor'], 0, true);
297 Logger::info('Ignoring actor because of thread completion.');
298 $item['owner-link'] = $item['author-link'];
299 $item['owner-id'] = $item['author-id'];
302 $item['uri'] = $activity['id'];
303 $content = HTML::toBBCode($activity['content']);
304 $content = self::replaceEmojis($content, $activity['emojis']);
305 $content = self::convertMentions($content);
307 if (($item['thr-parent'] != $item['uri']) && ($item['gravity'] == GRAVITY_COMMENT)) {
308 $item_private = !in_array(0, $activity['item_receiver']);
309 $parent = Item::selectFirst(['id', 'private', 'author-link', 'alias'], ['uri' => $item['thr-parent']]);
310 if (!DBA::isResult($parent)) {
313 if ($item_private && !$parent['private']) {
314 Logger::warning('Item is private but the parent is not. Dropping.', ['item-uri' => $item['uri'], 'thr-parent' => $item['thr-parent']]);
318 $potential_implicit_mentions = self::getImplicitMentionList($parent);
319 $content = self::removeImplicitMentionsFromBody($content, $potential_implicit_mentions);
320 $activity['tags'] = self::convertImplicitMentionsInTags($activity['tags'], $potential_implicit_mentions);
323 $item['created'] = $activity['published'];
324 $item['edited'] = $activity['updated'];
325 $item['guid'] = $activity['diaspora:guid'];
326 $item['title'] = HTML::toBBCode($activity['name']);
327 $item['content-warning'] = HTML::toBBCode($activity['summary']);
328 $item['body'] = $content;
330 if (($activity['object_type'] == 'as:Video') && !empty($activity['alternate-url'])) {
331 $item['body'] .= "\n[video]" . $activity['alternate-url'] . '[/video]';
334 $item['location'] = $activity['location'];
336 if (!empty($item['latitude']) && !empty($item['longitude'])) {
337 $item['coord'] = $item['latitude'] . ' ' . $item['longitude'];
340 $item['tag'] = self::constructTagString($activity['tags'], $activity['sensitive']);
341 $item['app'] = $activity['generator'];
342 $item['plink'] = defaults($activity, 'alternate-url', $item['uri']);
344 $item = self::constructAttachList($activity['attachments'], $item);
346 if (!empty($activity['source'])) {
347 $item['content-warning'] = '';
348 $item['body'] = $activity['source'];
353 foreach ($activity['receiver'] as $receiver) {
354 $item['uid'] = $receiver;
355 $item['contact-id'] = Contact::getIdForURL($activity['author'], $receiver, true);
357 if (($receiver != 0) && empty($item['contact-id'])) {
358 $item['contact-id'] = Contact::getIdForURL($activity['author'], 0, true);
361 if ($activity['object_type'] == 'as:Event') {
362 self::createEvent($activity, $item);
365 $item_id = Item::insert($item);
367 Logger::info('Item insertion successful', ['user' => $item['uid'], 'item_id' => $item_id]);
369 Logger::notice('Item insertion aborted', ['user' => $item['uid']]);
372 if ($item['uid'] == 0) {
377 // Store send a follow request for every reshare - but only when the item had been stored
378 if ($stored && !$item['private'] && ($item['gravity'] == GRAVITY_PARENT) && ($item['author-link'] != $item['owner-link'])) {
379 $author = APContact::getByURL($item['owner-link'], false);
380 // We send automatic follow requests for reshared messages. (We don't need though for forum posts)
381 if ($author['type'] != 'Group') {
382 Logger::log('Send follow request for ' . $item['uri'] . ' (' . $stored . ') to ' . $item['author-link'], Logger::DEBUG);
383 ActivityPub\Transmitter::sendFollowObject($item['uri'], $item['author-link']);
389 * Fetches missing posts
393 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
395 private static function fetchMissingActivity($url, $child)
397 if (Config::get('system', 'ostatus_full_threads')) {
401 $uid = ActivityPub\Receiver::getFirstUserFromReceivers($child['receiver']);
403 $object = ActivityPub::fetchContent($url, $uid);
404 if (empty($object)) {
405 Logger::log('Activity ' . $url . ' was not fetchable, aborting.');
409 if (empty($object['id'])) {
410 Logger::log('Activity ' . $url . ' has got not id, aborting. ' . json_encode($object));
415 $activity['@context'] = $object['@context'];
416 unset($object['@context']);
417 $activity['id'] = $object['id'];
418 $activity['to'] = defaults($object, 'to', []);
419 $activity['cc'] = defaults($object, 'cc', []);
420 $activity['actor'] = $child['author'];
421 $activity['object'] = $object;
422 $activity['published'] = defaults($object, 'published', $child['published']);
423 $activity['type'] = 'Create';
425 $ldactivity = JsonLD::compact($activity);
427 $ldactivity['thread-completion'] = true;
429 ActivityPub\Receiver::processActivity($ldactivity);
430 Logger::log('Activity ' . $url . ' had been fetched and processed.');
434 * perform a "follow" request
436 * @param array $activity
437 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
438 * @throws \ImagickException
440 public static function followUser($activity)
442 $uid = User::getIdForURL($activity['object_id']);
447 $owner = User::getOwnerDataById($uid);
449 $cid = Contact::getIdForURL($activity['actor'], $uid);
451 self::switchContact($cid);
452 DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
453 $contact = DBA::selectFirst('contact', [], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
458 $item = ['author-id' => Contact::getIdForURL($activity['actor']),
459 'author-link' => $activity['actor']];
461 // Ensure that the contact has got the right network type
462 self::switchContact($item['author-id']);
464 Contact::addRelationship($owner, $contact, $item);
465 $cid = Contact::getIdForURL($activity['actor'], $uid);
470 if (empty($contact)) {
471 DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
474 Logger::log('Follow user ' . $uid . ' from contact ' . $cid . ' with id ' . $activity['id']);
478 * Update the given profile
480 * @param array $activity
483 public static function updatePerson($activity)
485 if (empty($activity['object_id'])) {
489 Logger::log('Updating profile for ' . $activity['object_id'], Logger::DEBUG);
490 APContact::getByURL($activity['object_id'], true);
494 * Delete the given profile
496 * @param array $activity
497 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
499 public static function deletePerson($activity)
501 if (empty($activity['object_id']) || empty($activity['actor'])) {
502 Logger::log('Empty object id or actor.', Logger::DEBUG);
506 if ($activity['object_id'] != $activity['actor']) {
507 Logger::log('Object id does not match actor.', Logger::DEBUG);
511 $contacts = DBA::select('contact', ['id'], ['nurl' => Strings::normaliseLink($activity['object_id'])]);
512 while ($contact = DBA::fetch($contacts)) {
513 Contact::remove($contact['id']);
515 DBA::close($contacts);
517 Logger::log('Deleted contact ' . $activity['object_id'], Logger::DEBUG);
521 * Accept a follow request
523 * @param array $activity
524 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
525 * @throws \ImagickException
527 public static function acceptFollowUser($activity)
529 $uid = User::getIdForURL($activity['object_actor']);
534 $cid = Contact::getIdForURL($activity['actor'], $uid);
536 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
540 self::switchContact($cid);
542 $fields = ['pending' => false];
544 $contact = DBA::selectFirst('contact', ['rel'], ['id' => $cid]);
545 if ($contact['rel'] == Contact::FOLLOWER) {
546 $fields['rel'] = Contact::FRIEND;
549 $condition = ['id' => $cid];
550 DBA::update('contact', $fields, $condition);
551 Logger::log('Accept contact request from contact ' . $cid . ' for user ' . $uid, Logger::DEBUG);
555 * Reject a follow request
557 * @param array $activity
558 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
559 * @throws \ImagickException
561 public static function rejectFollowUser($activity)
563 $uid = User::getIdForURL($activity['object_actor']);
568 $cid = Contact::getIdForURL($activity['actor'], $uid);
570 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
574 self::switchContact($cid);
576 if (DBA::exists('contact', ['id' => $cid, 'rel' => Contact::SHARING, 'pending' => true])) {
577 Contact::remove($cid);
578 Logger::log('Rejected contact request from contact ' . $cid . ' for user ' . $uid . ' - contact had been removed.', Logger::DEBUG);
580 Logger::log('Rejected contact request from contact ' . $cid . ' for user ' . $uid . '.', Logger::DEBUG);
585 * Undo activity like "like" or "dislike"
587 * @param array $activity
588 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
589 * @throws \ImagickException
591 public static function undoActivity($activity)
593 if (empty($activity['object_id'])) {
597 if (empty($activity['object_actor'])) {
601 $author_id = Contact::getIdForURL($activity['object_actor']);
602 if (empty($author_id)) {
606 Item::delete(['uri' => $activity['object_id'], 'author-id' => $author_id, 'gravity' => GRAVITY_ACTIVITY]);
610 * Activity to remove a follower
612 * @param array $activity
613 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
614 * @throws \ImagickException
616 public static function undoFollowUser($activity)
618 $uid = User::getIdForURL($activity['object_object']);
623 $owner = User::getOwnerDataById($uid);
625 $cid = Contact::getIdForURL($activity['actor'], $uid);
627 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
631 self::switchContact($cid);
633 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
634 if (!DBA::isResult($contact)) {
638 Contact::removeFollower($owner, $contact);
639 Logger::log('Undo following request from contact ' . $cid . ' for user ' . $uid, Logger::DEBUG);
643 * Switches a contact to AP if needed
645 * @param integer $cid Contact ID
648 private static function switchContact($cid)
650 $contact = DBA::selectFirst('contact', ['network'], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
651 if (!DBA::isResult($contact) || ($contact['network'] == Protocol::ACTIVITYPUB)) {
655 Logger::log('Change existing contact ' . $cid . ' from ' . $contact['network'] . ' to ActivityPub.');
656 Contact::updateFromProbe($cid, Protocol::ACTIVITYPUB);
660 * Collects implicit mentions like:
661 * - the author of the parent item
662 * - all the mentioned conversants in the parent item
664 * @param array $parent Item array with at least ['id', 'author-link', 'alias']
666 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
668 private static function getImplicitMentionList(array $parent)
670 if (Config::get('system', 'disable_implicit_mentions')) {
674 $parent_terms = Term::tagArrayFromItemId($parent['id'], [Term::MENTION, Term::IMPLICIT_MENTION]);
676 $parent_author = Contact::getDetailsByURL($parent['author-link'], 0);
678 $implicit_mentions = [];
679 if (empty($parent_author)) {
680 Logger::notice('Author public contact unknown.', ['author-link' => $parent['author-link'], 'item-id' => $parent['id']]);
682 $implicit_mentions[] = $parent_author['url'];
683 $implicit_mentions[] = $parent_author['nurl'];
684 $implicit_mentions[] = $parent_author['alias'];
687 if (!empty($parent['alias'])) {
688 $implicit_mentions[] = $parent['alias'];
691 foreach ($parent_terms as $term) {
692 $contact = Contact::getDetailsByURL($term['url'], 0);
693 if (!empty($contact)) {
694 $implicit_mentions[] = $contact['url'];
695 $implicit_mentions[] = $contact['nurl'];
696 $implicit_mentions[] = $contact['alias'];
700 return $implicit_mentions;
704 * Strips from the body prepended implicit mentions
706 * @param string $body
707 * @param array $potential_mentions
710 private static function removeImplicitMentionsFromBody($body, array $potential_mentions)
712 if (Config::get('system', 'disable_implicit_mentions')) {
718 // Extract one prepended mention at a time from the body
719 while(preg_match('#^(@\[url=([^\]]+)].*?\[\/url]\s)(.*)#is', $body, $matches)) {
720 if (!in_array($matches[2], $potential_mentions) ) {
721 $kept_mentions[] = $matches[1];
727 // Re-appending the kept mentions to the body after extraction
728 $kept_mentions[] = $body;
730 return implode('', $kept_mentions);
733 private static function convertImplicitMentionsInTags($activity_tags, array $potential_mentions)
735 if (Config::get('system', 'disable_implicit_mentions')) {
736 return $activity_tags;
739 foreach ($activity_tags as $index => $tag) {
740 if (in_array($tag['href'], $potential_mentions)) {
741 $activity_tags[$index]['name'] = preg_replace(
742 '/' . preg_quote(Term::TAG_CHARACTER[Term::MENTION], '/') . '/',
743 Term::TAG_CHARACTER[Term::IMPLICIT_MENTION],
744 $activity_tags[$index]['name'],
750 return $activity_tags;