3 * @file src/Protocol/ActivityPub/Processor.php
5 namespace Friendica\Protocol\ActivityPub;
7 use Friendica\Database\DBA;
8 use Friendica\Content\Text\BBCode;
9 use Friendica\Content\Text\HTML;
10 use Friendica\Core\Config;
11 use Friendica\Core\Logger;
12 use Friendica\Core\Protocol;
13 use Friendica\Model\Contact;
14 use Friendica\Model\APContact;
15 use Friendica\Model\Item;
16 use Friendica\Model\Event;
17 use Friendica\Model\Term;
18 use Friendica\Model\User;
19 use Friendica\Model\Mail;
20 use Friendica\Protocol\ActivityPub;
21 use Friendica\Util\DateTimeFormat;
22 use Friendica\Util\JsonLD;
23 use Friendica\Util\Strings;
26 * ActivityPub Processor Protocol class
31 * Converts mentions from Pleroma into the Friendica format
35 * @return string converted body
37 private static function convertMentions($body)
39 $URLSearchString = "^\[\]";
40 $body = preg_replace("/\[url\=([$URLSearchString]*)\]([#@!])(.*?)\[\/url\]/ism", '$2[url=$1]$3[/url]', $body);
46 * Replaces emojis in the body
48 * @param array $emojis
51 * @return string with replaced emojis
53 private static function replaceEmojis($body, array $emojis)
55 foreach ($emojis as $emoji) {
56 $replace = '[class=emoji mastodon][img=' . $emoji['href'] . ']' . $emoji['name'] . '[/img][/class]';
57 $body = str_replace($emoji['name'], $replace, $body);
63 * Constructs a string with tags for a given tag array
66 * @param boolean $sensitive
67 * @return string with tags
69 private static function constructTagString(array $tags = null, $sensitive = false)
76 foreach ($tags as $tag) {
77 if (in_array(defaults($tag, 'type', ''), ['Mention', 'Hashtag'])) {
78 if (!empty($tag_text)) {
82 $tag_text .= substr($tag['name'], 0, 1) . '[url=' . $tag['href'] . ']' . substr($tag['name'], 1) . '[/url]';
86 /// @todo add nsfw for $sensitive
92 * Add attachment data to the item array
94 * @param array $attachments
96 * @param boolean $no_images
100 private static function constructAttachList($attachments, $item, $no_images)
102 if (empty($attachments)) {
106 foreach ($attachments as $attach) {
107 $filetype = strtolower(substr($attach['mediaType'], 0, strpos($attach['mediaType'], '/')));
108 if ($filetype == 'image') {
113 $item['body'] .= "\n[img]" . $attach['url'] . '[/img]';
115 if (!empty($item["attach"])) {
116 $item["attach"] .= ',';
118 $item["attach"] = '';
120 if (!isset($attach['length'])) {
121 $attach['length'] = "0";
123 $item["attach"] .= '[attach]href="'.$attach['url'].'" length="'.$attach['length'].'" type="'.$attach['mediaType'].'" title="'.defaults($attach, 'name', '').'"[/attach]';
133 * @param array $activity Activity array
134 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
136 public static function updateItem($activity)
138 $item = Item::selectFirst(['uri', 'thr-parent', 'gravity'], ['uri' => $activity['id']]);
139 if (!DBA::isResult($item)) {
140 Logger::warning('Unknown item', ['uri' => $activity['id']]);
144 $item['changed'] = DateTimeFormat::utcNow();
145 $item['edited'] = $activity['updated'];
147 $item = self::processContent($activity, $item);
152 Item::update($item, ['uri' => $activity['id']]);
156 * Prepares data for a message
158 * @param array $activity Activity array
159 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
160 * @throws \ImagickException
162 public static function createItem($activity)
165 $item['verb'] = ACTIVITY_POST;
166 $item['thr-parent'] = $activity['reply-to-id'];
168 if ($activity['reply-to-id'] == $activity['id']) {
169 $item['gravity'] = GRAVITY_PARENT;
170 $item['object-type'] = ACTIVITY_OBJ_NOTE;
172 $item['gravity'] = GRAVITY_COMMENT;
173 $item['object-type'] = ACTIVITY_OBJ_COMMENT;
176 if (empty($activity['directmessage']) && ($activity['id'] != $activity['reply-to-id']) && !Item::exists(['uri' => $activity['reply-to-id']])) {
177 Logger::log('Parent ' . $activity['reply-to-id'] . ' not found. Try to refetch it.');
178 self::fetchMissingActivity($activity['reply-to-id'], $activity);
181 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:comment', '');
183 self::postItem($activity, $item);
189 * @param array $activity
190 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
191 * @throws \ImagickException
193 public static function deleteItem($activity)
195 $owner = Contact::getIdForURL($activity['actor']);
197 Logger::log('Deleting item ' . $activity['object_id'] . ' from ' . $owner, Logger::DEBUG);
198 Item::delete(['uri' => $activity['object_id'], 'owner-id' => $owner]);
202 * Prepare the item array for an activity
204 * @param array $activity Activity array
205 * @param string $verb Activity verb
206 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
207 * @throws \ImagickException
209 public static function createActivity($activity, $verb)
212 $item['verb'] = $verb;
213 $item['thr-parent'] = $activity['object_id'];
214 $item['gravity'] = GRAVITY_ACTIVITY;
215 $item['object-type'] = ACTIVITY_OBJ_NOTE;
217 $item['diaspora_signed_text'] = defaults($activity, 'diaspora:like', '');
219 self::postItem($activity, $item);
225 * @param array $activity Activity array
229 public static function createEvent($activity, $item)
231 $event['summary'] = HTML::toBBCode($activity['name']);
232 $event['desc'] = HTML::toBBCode($activity['content']);
233 $event['start'] = $activity['start-time'];
234 $event['finish'] = $activity['end-time'];
235 $event['nofinish'] = empty($event['finish']);
236 $event['location'] = $activity['location'];
237 $event['adjust'] = true;
238 $event['cid'] = $item['contact-id'];
239 $event['uid'] = $item['uid'];
240 $event['uri'] = $item['uri'];
241 $event['edited'] = $item['edited'];
242 $event['private'] = $item['private'];
243 $event['guid'] = $item['guid'];
244 $event['plink'] = $item['plink'];
246 $condition = ['uri' => $item['uri'], 'uid' => $item['uid']];
247 $ev = DBA::selectFirst('event', ['id'], $condition);
248 if (DBA::isResult($ev)) {
249 $event['id'] = $ev['id'];
252 $event_id = Event::store($event);
253 Logger::log('Event '.$event_id.' was stored', Logger::DEBUG);
257 * Process the content
259 * @param array $activity Activity array
261 * @return array|bool Returns the item array or false if there was an unexpected occurrence
264 private static function processContent($activity, $item)
266 $item['title'] = HTML::toBBCode($activity['name']);
268 if (!empty($activity['source'])) {
269 $item['body'] = $activity['source'];
271 $content = HTML::toBBCode($activity['content']);
273 if (!empty($activity['emojis'])) {
274 $content = self::replaceEmojis($content, $activity['emojis']);
277 $content = self::convertMentions($content);
279 if (empty($activity['directmessage']) && ($item['thr-parent'] != $item['uri']) && ($item['gravity'] == GRAVITY_COMMENT)) {
280 $item_private = !in_array(0, $activity['item_receiver']);
281 $parent = Item::selectFirst(['id', 'private', 'author-link', 'alias'], ['uri' => $item['thr-parent']]);
282 if (!DBA::isResult($parent)) {
283 Logger::warning('Unknown parent item.', ['uri' => $item['thr-parent']]);
286 if ($item_private && !$parent['private']) {
287 Logger::warning('Item is private but the parent is not. Dropping.', ['item-uri' => $item['uri'], 'thr-parent' => $item['thr-parent']]);
291 $potential_implicit_mentions = self::getImplicitMentionList($parent);
292 $content = self::removeImplicitMentionsFromBody($content, $potential_implicit_mentions);
293 $activity['tags'] = self::convertImplicitMentionsInTags($activity['tags'], $potential_implicit_mentions);
295 $item['content-warning'] = HTML::toBBCode($activity['summary']);
296 $item['body'] = $content;
298 if (($activity['object_type'] == 'as:Video') && !empty($activity['alternate-url'])) {
299 $item['body'] .= "\n[video]" . $activity['alternate-url'] . '[/video]';
303 $item['tag'] = self::constructTagString($activity['tags'], $activity['sensitive']);
305 $item['location'] = $activity['location'];
307 if (!empty($item['latitude']) && !empty($item['longitude'])) {
308 $item['coord'] = $item['latitude'] . ' ' . $item['longitude'];
311 $item['app'] = $activity['generator'];
317 * Creates an item post
319 * @param array $activity Activity data
320 * @param array $item item array
321 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
322 * @throws \ImagickException
324 private static function postItem($activity, $item)
326 /// @todo What to do with $activity['context']?
327 if (empty($activity['directmessage']) && ($item['gravity'] != GRAVITY_PARENT) && !Item::exists(['uri' => $item['thr-parent']])) {
328 Logger::info('Parent not found, message will be discarded.', ['thr-parent' => $item['thr-parent']]);
332 $item['network'] = Protocol::ACTIVITYPUB;
333 $item['private'] = !in_array(0, $activity['receiver']);
334 $item['author-link'] = $activity['author'];
335 $item['author-id'] = Contact::getIdForURL($activity['author'], 0, true);
337 if (empty($activity['thread-completion'])) {
338 $item['owner-link'] = $activity['actor'];
339 $item['owner-id'] = Contact::getIdForURL($activity['actor'], 0, true);
341 Logger::info('Ignoring actor because of thread completion.');
342 $item['owner-link'] = $item['author-link'];
343 $item['owner-id'] = $item['author-id'];
346 $item['uri'] = $activity['id'];
348 $item['created'] = $activity['published'];
349 $item['edited'] = $activity['updated'];
350 $item['guid'] = $activity['diaspora:guid'];
352 $item = self::processContent($activity, $item);
357 $item['plink'] = defaults($activity, 'alternate-url', $item['uri']);
359 $item = self::constructAttachList($activity['attachments'], $item, !empty($activity['source']));
363 foreach ($activity['receiver'] as $receiver) {
364 $item['uid'] = $receiver;
365 $item['contact-id'] = Contact::getIdForURL($activity['author'], $receiver, true);
367 if (($receiver != 0) && empty($item['contact-id'])) {
368 $item['contact-id'] = Contact::getIdForURL($activity['author'], 0, true);
371 if (!empty($activity['directmessage'])) {
372 self::postMail($activity, $item);
376 if ($activity['object_type'] == 'as:Event') {
377 self::createEvent($activity, $item);
380 $item_id = Item::insert($item);
382 Logger::info('Item insertion successful', ['user' => $item['uid'], 'item_id' => $item_id]);
384 Logger::notice('Item insertion aborted', ['user' => $item['uid']]);
387 if ($item['uid'] == 0) {
392 // Store send a follow request for every reshare - but only when the item had been stored
393 if ($stored && !$item['private'] && ($item['gravity'] == GRAVITY_PARENT) && ($item['author-link'] != $item['owner-link'])) {
394 $author = APContact::getByURL($item['owner-link'], false);
395 // We send automatic follow requests for reshared messages. (We don't need though for forum posts)
396 if ($author['type'] != 'Group') {
397 Logger::log('Send follow request for ' . $item['uri'] . ' (' . $stored . ') to ' . $item['author-link'], Logger::DEBUG);
398 ActivityPub\Transmitter::sendFollowObject($item['uri'], $item['author-link']);
404 * Creates an mail post
406 * @param array $activity Activity data
407 * @param array $item item array
408 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
409 * @throws \ImagickException
411 private static function postMail($activity, $item)
413 if (($item['gravity'] != GRAVITY_PARENT) && !DBA::exists('mail', ['uri' => $item['thr-parent'], 'uid' => $item['uid']])) {
414 Logger::info('Parent not found, mail will be discarded.', ['uid' => $item['uid'], 'uri' => $item['thr-parent']]);
418 Logger::info('Direct Message', $item);
421 $msg['uid'] = $item['uid'];
423 $msg['contact-id'] = $item['contact-id'];
425 $contact = Contact::getById($item['contact-id'], ['name', 'url', 'photo']);
426 $msg['from-name'] = $contact['name'];
427 $msg['from-url'] = $contact['url'];
428 $msg['from-photo'] = $contact['photo'];
430 $msg['uri'] = $item['uri'];
431 $msg['created'] = $item['created'];
433 $parent = DBA::selectFirst('mail', ['parent-uri', 'title'], ['uri' => $item['thr-parent']]);
434 if (DBA::isResult($parent)) {
435 $msg['parent-uri'] = $parent['parent-uri'];
436 $msg['title'] = $parent['title'];
438 $msg['parent-uri'] = $item['thr-parent'];
440 if (!empty($item['title'])) {
441 $msg['title'] = $item['title'];
442 } elseif (!empty($item['content-warning'])) {
443 $msg['title'] = $item['content-warning'];
445 // Trying to generate a title out of the body
446 $title = $item['body'];
448 while (preg_match('#^(@\[url=([^\]]+)].*?\[\/url]\s)(.*)#is', $title, $matches)) {
449 $title = $matches[3];
452 $title = trim(HTML::toPlaintext(BBCode::convert($title, false, 2, true), 0));
454 if (strlen($title) > 20) {
455 $title = substr($title, 0, 20) . '...';
458 $msg['title'] = $title;
461 $msg['body'] = $item['body'];
467 * Fetches missing posts
471 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
473 private static function fetchMissingActivity($url, $child)
475 if (Config::get('system', 'ostatus_full_threads')) {
479 $uid = ActivityPub\Receiver::getFirstUserFromReceivers($child['receiver']);
481 $object = ActivityPub::fetchContent($url, $uid);
482 if (empty($object)) {
483 Logger::log('Activity ' . $url . ' was not fetchable, aborting.');
487 if (empty($object['id'])) {
488 Logger::log('Activity ' . $url . ' has got not id, aborting. ' . json_encode($object));
493 $activity['@context'] = $object['@context'];
494 unset($object['@context']);
495 $activity['id'] = $object['id'];
496 $activity['to'] = defaults($object, 'to', []);
497 $activity['cc'] = defaults($object, 'cc', []);
498 $activity['actor'] = $child['author'];
499 $activity['object'] = $object;
500 $activity['published'] = defaults($object, 'published', $child['published']);
501 $activity['type'] = 'Create';
503 $ldactivity = JsonLD::compact($activity);
505 $ldactivity['thread-completion'] = true;
507 ActivityPub\Receiver::processActivity($ldactivity);
508 Logger::log('Activity ' . $url . ' had been fetched and processed.');
512 * perform a "follow" request
514 * @param array $activity
515 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
516 * @throws \ImagickException
518 public static function followUser($activity)
520 $uid = User::getIdForURL($activity['object_id']);
525 $owner = User::getOwnerDataById($uid);
527 $cid = Contact::getIdForURL($activity['actor'], $uid);
529 self::switchContact($cid);
530 DBA::update('contact', ['hub-verify' => $activity['id'], 'protocol' => Protocol::ACTIVITYPUB], ['id' => $cid]);
531 $contact = DBA::selectFirst('contact', [], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
536 $item = ['author-id' => Contact::getIdForURL($activity['actor']),
537 'author-link' => $activity['actor']];
539 $note = Strings::escapeTags(trim(defaults($activity, 'content', '')));
541 // Ensure that the contact has got the right network type
542 self::switchContact($item['author-id']);
544 $result = Contact::addRelationship($owner, $contact, $item, false, $note);
545 $cid = Contact::getIdForURL($activity['actor'], $uid);
550 if (empty($contact)) {
551 DBA::update('contact', ['hub-verify' => $activity['id'], 'protocol' => Protocol::ACTIVITYPUB], ['id' => $cid]);
554 Logger::log('Follow user ' . $uid . ' from contact ' . $cid . ' with id ' . $activity['id']);
558 * Update the given profile
560 * @param array $activity
563 public static function updatePerson($activity)
565 if (empty($activity['object_id'])) {
569 Logger::log('Updating profile for ' . $activity['object_id'], Logger::DEBUG);
570 APContact::getByURL($activity['object_id'], true);
574 * Delete the given profile
576 * @param array $activity
577 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
579 public static function deletePerson($activity)
581 if (empty($activity['object_id']) || empty($activity['actor'])) {
582 Logger::log('Empty object id or actor.', Logger::DEBUG);
586 if ($activity['object_id'] != $activity['actor']) {
587 Logger::log('Object id does not match actor.', Logger::DEBUG);
591 $contacts = DBA::select('contact', ['id'], ['nurl' => Strings::normaliseLink($activity['object_id'])]);
592 while ($contact = DBA::fetch($contacts)) {
593 Contact::remove($contact['id']);
595 DBA::close($contacts);
597 Logger::log('Deleted contact ' . $activity['object_id'], Logger::DEBUG);
601 * Accept a follow request
603 * @param array $activity
604 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
605 * @throws \ImagickException
607 public static function acceptFollowUser($activity)
609 $uid = User::getIdForURL($activity['object_actor']);
614 $cid = Contact::getIdForURL($activity['actor'], $uid);
616 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
620 self::switchContact($cid);
622 $fields = ['pending' => false];
624 $contact = DBA::selectFirst('contact', ['rel'], ['id' => $cid]);
625 if ($contact['rel'] == Contact::FOLLOWER) {
626 $fields['rel'] = Contact::FRIEND;
629 $condition = ['id' => $cid];
630 DBA::update('contact', $fields, $condition);
631 Logger::log('Accept contact request from contact ' . $cid . ' for user ' . $uid, Logger::DEBUG);
635 * Reject a follow request
637 * @param array $activity
638 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
639 * @throws \ImagickException
641 public static function rejectFollowUser($activity)
643 $uid = User::getIdForURL($activity['object_actor']);
648 $cid = Contact::getIdForURL($activity['actor'], $uid);
650 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
654 self::switchContact($cid);
656 if (DBA::exists('contact', ['id' => $cid, 'rel' => Contact::SHARING])) {
657 Contact::remove($cid);
658 Logger::log('Rejected contact request from contact ' . $cid . ' for user ' . $uid . ' - contact had been removed.', Logger::DEBUG);
660 Logger::log('Rejected contact request from contact ' . $cid . ' for user ' . $uid . '.', Logger::DEBUG);
665 * Undo activity like "like" or "dislike"
667 * @param array $activity
668 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
669 * @throws \ImagickException
671 public static function undoActivity($activity)
673 if (empty($activity['object_id'])) {
677 if (empty($activity['object_actor'])) {
681 $author_id = Contact::getIdForURL($activity['object_actor']);
682 if (empty($author_id)) {
686 Item::delete(['uri' => $activity['object_id'], 'author-id' => $author_id, 'gravity' => GRAVITY_ACTIVITY]);
690 * Activity to remove a follower
692 * @param array $activity
693 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
694 * @throws \ImagickException
696 public static function undoFollowUser($activity)
698 $uid = User::getIdForURL($activity['object_object']);
703 $owner = User::getOwnerDataById($uid);
705 $cid = Contact::getIdForURL($activity['actor'], $uid);
707 Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
711 self::switchContact($cid);
713 $contact = DBA::selectFirst('contact', [], ['id' => $cid]);
714 if (!DBA::isResult($contact)) {
718 Contact::removeFollower($owner, $contact);
719 Logger::log('Undo following request from contact ' . $cid . ' for user ' . $uid, Logger::DEBUG);
723 * Switches a contact to AP if needed
725 * @param integer $cid Contact ID
728 private static function switchContact($cid)
730 $contact = DBA::selectFirst('contact', ['network'], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
731 if (!DBA::isResult($contact) || in_array($contact['network'], [Protocol::ACTIVITYPUB, Protocol::DFRN])) {
735 Logger::log('Change existing contact ' . $cid . ' from ' . $contact['network'] . ' to ActivityPub.');
736 Contact::updateFromProbe($cid, Protocol::ACTIVITYPUB);
740 * Collects implicit mentions like:
741 * - the author of the parent item
742 * - all the mentioned conversants in the parent item
744 * @param array $parent Item array with at least ['id', 'author-link', 'alias']
746 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
748 private static function getImplicitMentionList(array $parent)
750 if (Config::get('system', 'disable_implicit_mentions')) {
754 $parent_terms = Term::tagArrayFromItemId($parent['id'], [Term::MENTION, Term::IMPLICIT_MENTION]);
756 $parent_author = Contact::getDetailsByURL($parent['author-link'], 0);
758 $implicit_mentions = [];
759 if (empty($parent_author)) {
760 Logger::notice('Author public contact unknown.', ['author-link' => $parent['author-link'], 'item-id' => $parent['id']]);
762 $implicit_mentions[] = $parent_author['url'];
763 $implicit_mentions[] = $parent_author['nurl'];
764 $implicit_mentions[] = $parent_author['alias'];
767 if (!empty($parent['alias'])) {
768 $implicit_mentions[] = $parent['alias'];
771 foreach ($parent_terms as $term) {
772 $contact = Contact::getDetailsByURL($term['url'], 0);
773 if (!empty($contact)) {
774 $implicit_mentions[] = $contact['url'];
775 $implicit_mentions[] = $contact['nurl'];
776 $implicit_mentions[] = $contact['alias'];
780 return $implicit_mentions;
784 * Strips from the body prepended implicit mentions
786 * @param string $body
787 * @param array $potential_mentions
790 private static function removeImplicitMentionsFromBody($body, array $potential_mentions)
792 if (Config::get('system', 'disable_implicit_mentions')) {
798 // Extract one prepended mention at a time from the body
799 while(preg_match('#^(@\[url=([^\]]+)].*?\[\/url]\s)(.*)#is', $body, $matches)) {
800 if (!in_array($matches[2], $potential_mentions) ) {
801 $kept_mentions[] = $matches[1];
807 // Re-appending the kept mentions to the body after extraction
808 $kept_mentions[] = $body;
810 return implode('', $kept_mentions);
813 private static function convertImplicitMentionsInTags($activity_tags, array $potential_mentions)
815 if (Config::get('system', 'disable_implicit_mentions')) {
816 return $activity_tags;
819 foreach ($activity_tags as $index => $tag) {
820 if (in_array($tag['href'], $potential_mentions)) {
821 $activity_tags[$index]['name'] = preg_replace(
822 '/' . preg_quote(Term::TAG_CHARACTER[Term::MENTION], '/') . '/',
823 Term::TAG_CHARACTER[Term::IMPLICIT_MENTION],
824 $activity_tags[$index]['name'],
830 return $activity_tags;