]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/ActivityPub/Processor.php
Clarified return values
[friendica.git] / src / Protocol / ActivityPub / Processor.php
index 1e5001010855ae68b8b8beaf25b75b6ed4903398..c38cba28f187419258727c62693323538b5edc03 100644 (file)
@@ -5,19 +5,20 @@
 namespace Friendica\Protocol\ActivityPub;
 
 use Friendica\Database\DBA;
+use Friendica\Content\Text\HTML;
+use Friendica\Core\Config;
 use Friendica\Core\Logger;
 use Friendica\Core\Protocol;
-use Friendica\Model\Conversation;
 use Friendica\Model\Contact;
 use Friendica\Model\APContact;
 use Friendica\Model\Item;
 use Friendica\Model\Event;
+use Friendica\Model\Term;
 use Friendica\Model\User;
-use Friendica\Content\Text\HTML;
-use Friendica\Util\JsonLD;
-use Friendica\Core\Config;
 use Friendica\Protocol\ActivityPub;
 use Friendica\Util\DateTimeFormat;
+use Friendica\Util\JsonLD;
+use Friendica\Util\Strings;
 
 /**
  * ActivityPub Processor Protocol class
@@ -29,7 +30,7 @@ class Processor
         *
         * @param string $body
         *
-        * @return converted body
+        * @return string converted body
         */
        private static function convertMentions($body)
        {
@@ -39,15 +40,32 @@ class Processor
                return $body;
        }
 
+       /**
+        * Replaces emojis in the body
+        *
+        * @param array $emojis
+        * @param string $body
+        *
+        * @return string with replaced emojis
+        */
+       public static function replaceEmojis($body, array $emojis)
+       {
+               foreach ($emojis as $emoji) {
+                       $replace = '[class=emoji mastodon][img=' . $emoji['href'] . ']' . $emoji['name'] . '[/img][/class]';
+                       $body = str_replace($emoji['name'], $replace, $body);
+               }
+               return $body;
+       }
+
        /**
         * Constructs a string with tags for a given tag array
         *
-        * @param array $tags
+        * @param array   $tags
         * @param boolean $sensitive
-        *
+        * @param array   $implicit_mentions List of profile URLs to skip
         * @return string with tags
         */
-       private static function constructTagList($tags, $sensitive)
+       private static function constructTagString(array $tags, $sensitive)
        {
                if (empty($tags)) {
                        return '';
@@ -75,7 +93,7 @@ class Processor
         * @param array $attachments
         * @param array $item
         *
-        * @return item array
+        * @return array array
         */
        private static function constructAttachList($attachments, $item)
        {
@@ -106,17 +124,24 @@ class Processor
        /**
         * Updates a message
         *
-        * @param array  $activity Activity array
+        * @param array $activity Activity array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function updateItem($activity)
        {
-               $item = [];
+               $item = Item::selectFirst(['uri', 'thr-parent', 'gravity'], ['uri' => $activity['id']]);
+               if (!DBA::isResult($item)) {
+                       Logger::warning('Unknown item', ['uri' => $activity['id']]);
+                       return;
+               }
+
                $item['changed'] = DateTimeFormat::utcNow();
                $item['edited'] = $activity['updated'];
-               $item['title'] = HTML::toBBCode($activity['name']);
-               $item['content-warning'] = HTML::toBBCode($activity['summary']);
-               $item['body'] = self::convertMentions(HTML::toBBCode($activity['content']));
-               $item['tag'] = self::constructTagList($activity['tags'], $activity['sensitive']);
+
+               $item = self::processContent($activity, $item);
+               if (empty($item)) {
+                       return;
+               }
 
                Item::update($item, ['uri' => $activity['id']]);
        }
@@ -124,13 +149,15 @@ class Processor
        /**
         * Prepares data for a message
         *
-        * @param array  $activity Activity array
+        * @param array $activity Activity array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function createItem($activity)
        {
                $item = [];
                $item['verb'] = ACTIVITY_POST;
-               $item['parent-uri'] = $activity['reply-to-id'];
+               $item['thr-parent'] = $activity['reply-to-id'];
 
                if ($activity['reply-to-id'] == $activity['id']) {
                        $item['gravity'] = GRAVITY_PARENT;
@@ -154,6 +181,8 @@ class Processor
         * Delete items
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function deleteItem($activity)
        {
@@ -168,12 +197,14 @@ class Processor
         *
         * @param array  $activity Activity array
         * @param string $verb     Activity verb
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function createActivity($activity, $verb)
        {
                $item = [];
                $item['verb'] = $verb;
-               $item['parent-uri'] = $activity['object_id'];
+               $item['thr-parent'] = $activity['object_id'];
                $item['gravity'] = GRAVITY_ACTIVITY;
                $item['object-type'] = ACTIVITY_OBJ_NOTE;
 
@@ -187,23 +218,24 @@ class Processor
         *
         * @param array $activity Activity array
         * @param array $item
+        * @throws \Exception
         */
        public static function createEvent($activity, $item)
        {
-               $event['summary'] = $activity['name'];
-               $event['desc'] = $activity['content'];
-               $event['start'] = $activity['start-time'];
-               $event['finish'] = $activity['end-time'];
+               $event['summary']  = HTML::toBBCode($activity['name']);
+               $event['desc']     = HTML::toBBCode($activity['content']);
+               $event['start']    = $activity['start-time'];
+               $event['finish']   = $activity['end-time'];
                $event['nofinish'] = empty($event['finish']);
                $event['location'] = $activity['location'];
-               $event['adjust'] = true;
-               $event['cid'] = $item['contact-id'];
-               $event['uid'] = $item['uid'];
-               $event['uri'] = $item['uri'];
-               $event['edited'] = $item['edited'];
-               $event['private'] = $item['private'];
-               $event['guid'] = $item['guid'];
-               $event['plink'] = $item['plink'];
+               $event['adjust']   = true;
+               $event['cid']      = $item['contact-id'];
+               $event['uid']      = $item['uid'];
+               $event['uri']      = $item['uri'];
+               $event['edited']   = $item['edited'];
+               $event['private']  = $item['private'];
+               $event['guid']     = $item['guid'];
+               $event['plink']    = $item['plink'];
 
                $condition = ['uri' => $item['uri'], 'uid' => $item['uid']];
                $ev = DBA::selectFirst('event', ['id'], $condition);
@@ -215,18 +247,76 @@ class Processor
                Logger::log('Event '.$event_id.' was stored', Logger::DEBUG);
        }
 
+       /**
+        * Process the content
+        *
+        * @param array $activity Activity array
+        * @param array $item
+        * @return array|bool Returns the item array or false if there was an unexpected occurrence
+        * @throws \Exception
+        */
+       private static function processContent($activity, $item)
+       {
+               $item['title'] = HTML::toBBCode($activity['name']);
+
+               if (!empty($activity['source'])) {
+                       $item['body'] = $activity['source'];
+               } else {
+                       $content = HTML::toBBCode($activity['content']);
+                       $content = self::replaceEmojis($content, $activity['emojis']);
+                       $content = self::convertMentions($content);
+
+                       if (($item['thr-parent'] != $item['uri']) && ($item['gravity'] == GRAVITY_COMMENT)) {
+                               $item_private = !in_array(0, $activity['item_receiver']);
+                               $parent = Item::selectFirst(['id', 'private', 'author-link', 'alias'], ['uri' => $item['thr-parent']]);
+                               if (!DBA::isResult($parent)) {
+                                       Logger::warning('Unknown parent item.', ['uri' => $item['thr-parent']]);
+                                       return false;
+                               }
+                               if ($item_private && !$parent['private']) {
+                                       Logger::warning('Item is private but the parent is not. Dropping.', ['item-uri' => $item['uri'], 'thr-parent' => $item['thr-parent']]);
+                                       return false;
+                               }
+
+                               $potential_implicit_mentions = self::getImplicitMentionList($parent);
+                               $content = self::removeImplicitMentionsFromBody($content, $potential_implicit_mentions);
+                               $activity['tags'] = self::convertImplicitMentionsInTags($activity['tags'], $potential_implicit_mentions);
+                       }
+                       $item['content-warning'] = HTML::toBBCode($activity['summary']);
+                       $item['body'] = $content;
+
+                       if (($activity['object_type'] == 'as:Video') && !empty($activity['alternate-url'])) {
+                               $item['body'] .= "\n[video]" . $activity['alternate-url'] . '[/video]';
+                       }
+               }
+
+               $item['tag'] = self::constructTagString($activity['tags'], $activity['sensitive']);
+
+               $item['location'] = $activity['location'];
+
+               if (!empty($item['latitude']) && !empty($item['longitude'])) {
+                       $item['coord'] = $item['latitude'] . ' ' . $item['longitude'];
+               }
+
+               $item['app'] = $activity['generator'];
+
+               return $item;
+       }
+
        /**
         * Creates an item post
         *
-        * @param array  $activity Activity data
-        * @param array  $item     item array
+        * @param array $activity Activity data
+        * @param array $item     item array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        private static function postItem($activity, $item)
        {
                /// @todo What to do with $activity['context']?
 
-               if (($item['gravity'] != GRAVITY_PARENT) && !Item::exists(['uri' => $item['parent-uri']])) {
-                       Logger::log('Parent ' . $item['parent-uri'] . ' not found, message will be discarded.', Logger::DEBUG);
+               if (($item['gravity'] != GRAVITY_PARENT) && !Item::exists(['uri' => $item['thr-parent']])) {
+                       Logger::info('Parent not found, message will be discarded.', ['thr-parent' => $item['thr-parent']]);
                        return;
                }
 
@@ -239,38 +329,27 @@ class Processor
                        $item['owner-link'] = $activity['actor'];
                        $item['owner-id'] = Contact::getIdForURL($activity['actor'], 0, true);
                } else {
-                       Logger::log('Ignoring actor because of thread completion.', Logger::DEBUG);
+                       Logger::info('Ignoring actor because of thread completion.');
                        $item['owner-link'] = $item['author-link'];
                        $item['owner-id'] = $item['author-id'];
                }
 
                $item['uri'] = $activity['id'];
+
                $item['created'] = $activity['published'];
                $item['edited'] = $activity['updated'];
                $item['guid'] = $activity['diaspora:guid'];
-               $item['title'] = HTML::toBBCode($activity['name']);
-               $item['content-warning'] = HTML::toBBCode($activity['summary']);
-               $item['body'] = self::convertMentions(HTML::toBBCode($activity['content']));
-
-               if (($activity['object_type'] == 'as:Video') && !empty($activity['alternate-url'])) {
-                       $item['body'] .= "\n[video]" . $activity['alternate-url'] . '[/video]';
-               }
 
-               $item['location'] = $activity['location'];
-
-               if (!empty($item['latitude']) && !empty($item['longitude'])) {
-                       $item['coord'] = $item['latitude'] . ' ' . $item['longitude'];
+               $item = self::processContent($activity, $item);
+               if (empty($item)) {
+                       return;
                }
 
-               $item['tag'] = self::constructTagList($activity['tags'], $activity['sensitive']);
-               $item['app'] = $activity['generator'];
                $item['plink'] = defaults($activity, 'alternate-url', $item['uri']);
 
                $item = self::constructAttachList($activity['attachments'], $item);
 
-               if (!empty($activity['source'])) {
-                       $item['body'] = $activity['source'];
-               }
+               $stored = false;
 
                foreach ($activity['receiver'] as $receiver) {
                        $item['uid'] = $receiver;
@@ -285,7 +364,25 @@ class Processor
                        }
 
                        $item_id = Item::insert($item);
-                       Logger::log('Storing for user ' . $item['uid'] . ': ' . $item_id);
+                       if ($item_id) {
+                               Logger::info('Item insertion successful', ['user' => $item['uid'], 'item_id' => $item_id]);
+                       } else {
+                               Logger::notice('Item insertion aborted', ['user' => $item['uid']]);
+                       }
+
+                       if ($item['uid'] == 0) {
+                               $stored = $item_id;
+                       }
+               }
+
+               // Store send a follow request for every reshare - but only when the item had been stored
+               if ($stored && !$item['private'] && ($item['gravity'] == GRAVITY_PARENT) && ($item['author-link'] != $item['owner-link'])) {
+                       $author = APContact::getByURL($item['owner-link'], false);
+                       // We send automatic follow requests for reshared messages. (We don't need though for forum posts)
+                       if ($author['type'] != 'Group') {
+                               Logger::log('Send follow request for ' . $item['uri'] . ' (' . $stored . ') to ' . $item['author-link'], Logger::DEBUG);
+                               ActivityPub\Transmitter::sendFollowObject($item['uri'], $item['author-link']);
+                       }
                }
        }
 
@@ -294,6 +391,7 @@ class Processor
         *
         * @param $url
         * @param $child
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function fetchMissingActivity($url, $child)
        {
@@ -309,6 +407,11 @@ class Processor
                        return;
                }
 
+               if (empty($object['id'])) {
+                       Logger::log('Activity ' . $url . ' has got not id, aborting. ' . json_encode($object));
+                       return;
+               }
+
                $activity = [];
                $activity['@context'] = $object['@context'];
                unset($object['@context']);
@@ -332,6 +435,8 @@ class Processor
         * perform a "follow" request
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function followUser($activity)
        {
@@ -345,6 +450,7 @@ class Processor
                $cid = Contact::getIdForURL($activity['actor'], $uid);
                if (!empty($cid)) {
                        self::switchContact($cid);
+                       DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
                        $contact = DBA::selectFirst('contact', [], ['id' => $cid, 'network' => Protocol::NATIVE_SUPPORT]);
                } else {
                        $contact = false;
@@ -362,7 +468,10 @@ class Processor
                        return;
                }
 
-               DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
+               if (empty($contact)) {
+                       DBA::update('contact', ['hub-verify' => $activity['id']], ['id' => $cid]);
+               }
+
                Logger::log('Follow user ' . $uid . ' from contact ' . $cid . ' with id ' . $activity['id']);
        }
 
@@ -370,6 +479,7 @@ class Processor
         * Update the given profile
         *
         * @param array $activity
+        * @throws \Exception
         */
        public static function updatePerson($activity)
        {
@@ -385,6 +495,7 @@ class Processor
         * Delete the given profile
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function deletePerson($activity)
        {
@@ -398,7 +509,7 @@ class Processor
                        return;
                }
 
-               $contacts = DBA::select('contact', ['id'], ['nurl' => normalise_link($activity['object_id'])]);
+               $contacts = DBA::select('contact', ['id'], ['nurl' => Strings::normaliseLink($activity['object_id'])]);
                while ($contact = DBA::fetch($contacts)) {
                        Contact::remove($contact['id']);
                }
@@ -411,6 +522,8 @@ class Processor
         * Accept a follow request
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function acceptFollowUser($activity)
        {
@@ -419,8 +532,6 @@ class Processor
                        return;
                }
 
-               $owner = User::getOwnerDataById($uid);
-
                $cid = Contact::getIdForURL($activity['actor'], $uid);
                if (empty($cid)) {
                        Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
@@ -445,6 +556,8 @@ class Processor
         * Reject a follow request
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function rejectFollowUser($activity)
        {
@@ -453,8 +566,6 @@ class Processor
                        return;
                }
 
-               $owner = User::getOwnerDataById($uid);
-
                $cid = Contact::getIdForURL($activity['actor'], $uid);
                if (empty($cid)) {
                        Logger::log('No contact found for ' . $activity['actor'], Logger::DEBUG);
@@ -475,6 +586,8 @@ class Processor
         * Undo activity like "like" or "dislike"
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function undoActivity($activity)
        {
@@ -498,6 +611,8 @@ class Processor
         * Activity to remove a follower
         *
         * @param array $activity
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function undoFollowUser($activity)
        {
@@ -529,6 +644,7 @@ class Processor
         * Switches a contact to AP if needed
         *
         * @param integer $cid Contact ID
+        * @throws \Exception
         */
        private static function switchContact($cid)
        {
@@ -540,4 +656,98 @@ class Processor
                Logger::log('Change existing contact ' . $cid . ' from ' . $contact['network'] . ' to ActivityPub.');
                Contact::updateFromProbe($cid, Protocol::ACTIVITYPUB);
        }
+
+       /**
+        * Collects implicit mentions like:
+        * - the author of the parent item
+        * - all the mentioned conversants in the parent item
+        *
+        * @param array $parent Item array with at least ['id', 'author-link', 'alias']
+        * @return array
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        */
+       private static function getImplicitMentionList(array $parent)
+       {
+               if (Config::get('system', 'disable_implicit_mentions')) {
+                       return [];
+               }
+
+               $parent_terms = Term::tagArrayFromItemId($parent['id'], [Term::MENTION, Term::IMPLICIT_MENTION]);
+
+               $parent_author = Contact::getDetailsByURL($parent['author-link'], 0);
+
+               $implicit_mentions = [];
+               if (empty($parent_author)) {
+                       Logger::notice('Author public contact unknown.', ['author-link' => $parent['author-link'], 'item-id' => $parent['id']]);
+               } else {
+                       $implicit_mentions[] = $parent_author['url'];
+                       $implicit_mentions[] = $parent_author['nurl'];
+                       $implicit_mentions[] = $parent_author['alias'];
+               }
+
+               if (!empty($parent['alias'])) {
+                       $implicit_mentions[] = $parent['alias'];
+               }
+
+               foreach ($parent_terms as $term) {
+                       $contact = Contact::getDetailsByURL($term['url'], 0);
+                       if (!empty($contact)) {
+                               $implicit_mentions[] = $contact['url'];
+                               $implicit_mentions[] = $contact['nurl'];
+                               $implicit_mentions[] = $contact['alias'];
+                       }
+               }
+
+               return $implicit_mentions;
+       }
+
+       /**
+        * Strips from the body prepended implicit mentions
+        *
+        * @param string $body
+        * @param array $potential_mentions
+        * @return string
+        */
+       private static function removeImplicitMentionsFromBody($body, array $potential_mentions)
+       {
+               if (Config::get('system', 'disable_implicit_mentions')) {
+                       return $body;
+               }
+
+               $kept_mentions = [];
+
+               // Extract one prepended mention at a time from the body
+               while(preg_match('#^(@\[url=([^\]]+)].*?\[\/url]\s)(.*)#is', $body, $matches)) {
+                       if (!in_array($matches[2], $potential_mentions) ) {
+                               $kept_mentions[] = $matches[1];
+                       }
+
+                       $body = $matches[3];
+               }
+
+               // Re-appending the kept mentions to the body after extraction
+               $kept_mentions[] = $body;
+
+               return implode('', $kept_mentions);
+       }
+
+       private static function convertImplicitMentionsInTags($activity_tags, array $potential_mentions)
+       {
+               if (Config::get('system', 'disable_implicit_mentions')) {
+                       return $activity_tags;
+               }
+
+               foreach ($activity_tags as $index => $tag) {
+                       if (in_array($tag['href'], $potential_mentions)) {
+                               $activity_tags[$index]['name'] = preg_replace(
+                                       '/' . preg_quote(Term::TAG_CHARACTER[Term::MENTION], '/') . '/',
+                                       Term::TAG_CHARACTER[Term::IMPLICIT_MENTION],
+                                       $activity_tags[$index]['name'],
+                                       1
+                               );
+                       }
+               }
+
+               return $activity_tags;
+       }
 }