]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/ActivityPub/Receiver.php
Changes:
[friendica.git] / src / Protocol / ActivityPub / Receiver.php
index f9ddb6fd7a80e744323e9ff9b128a7357fac4bb9..33c027933ccac88601b838b07bc22b1df60b2415 100644 (file)
@@ -80,12 +80,13 @@ class Receiver
        /**
         * Checks incoming message from the inbox
         *
-        * @param         $body
-        * @param         $header
+        * @param string  $body Body string
+        * @param array   $header Header lines
         * @param integer $uid User ID
+        * @return void
         * @throws \Exception
         */
-       public static function processInbox($body, $header, $uid)
+       public static function processInbox(string $body, array $header, int $uid)
        {
                $activity = json_decode($body, true);
                if (empty($activity)) {
@@ -95,9 +96,9 @@ class Receiver
 
                $ldactivity = JsonLD::compact($activity);
 
-               $actor = JsonLD::fetchElement($ldactivity, 'as:actor', '@id');
-
+               $actor = JsonLD::fetchElement($ldactivity, 'as:actor', '@id') ?? '';
                $apcontact = APContact::getByURL($actor);
+
                if (empty($apcontact)) {
                        Logger::notice('Unable to retrieve AP contact for actor - message is discarded', ['actor' => $actor]);
                        return;
@@ -220,11 +221,11 @@ class Receiver
         * @param string  $object_id Object ID of the the provided object
         * @param integer $uid       User ID
         *
-        * @return string with object type
+        * @return string with object type or NULL
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       private static function fetchObjectType($activity, $object_id, $uid = 0)
+       private static function fetchObjectType(array $activity, string $object_id, int $uid = 0)
        {
                if (!empty($activity['as:object'])) {
                        $object_type = JsonLD::fetchElement($activity['as:object'], '@type');
@@ -268,7 +269,7 @@ class Receiver
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function prepareObjectData($activity, $uid, $push, &$trust_source)
+       public static function prepareObjectData(array $activity, int $uid, bool $push, bool &$trust_source): array
        {
                $id = JsonLD::fetchElement($activity, '@id');
                if (!empty($id) && !$trust_source) {
@@ -385,7 +386,7 @@ class Receiver
                        } else {
                                $object_data['directmessage'] = JsonLD::fetchElement($activity, 'litepub:directMessage');
                        }
-               } elseif (in_array($type, array_merge(self::ACTIVITY_TYPES, ['as:Follow'])) && in_array($object_type, self::CONTENT_TYPES)) {
+               } elseif (in_array($type, array_merge(self::ACTIVITY_TYPES, ['as:Follow', 'litepub:EmojiReact', 'as:View'])) && in_array($object_type, self::CONTENT_TYPES)) {
                        // Create a mostly empty array out of the activity data (instead of the object).
                        // This way we later don't have to check for the existence of each individual array element.
                        $object_data = self::processObject($activity);
@@ -458,7 +459,7 @@ class Receiver
         * @param array $receivers Array with receivers
         * @return integer user id;
         */
-       public static function getFirstUserFromReceivers($receivers)
+       public static function getFirstUserFromReceivers(array $receivers): int
        {
                foreach ($receivers as $receiver) {
                        if (!empty($receiver)) {
@@ -479,7 +480,7 @@ class Receiver
         * @param array   $signer       The signer of the post
         * @throws \Exception
         */
-       public static function processActivity($activity, string $body = '', int $uid = null, bool $trust_source = false, bool $push = false, array $signer = [])
+       public static function processActivity(array $activity, string $body = '', int $uid = null, bool $trust_source = false, bool $push = false, array $signer = [])
        {
                $type = JsonLD::fetchElement($activity, '@type');
                if (!$type) {
@@ -553,6 +554,10 @@ class Receiver
                        $object_data['from-relay'] = $activity['from-relay'];
                }
 
+               if (in_array('as:Question', [$object_data['object_type'] ?? '', $object_data['object_object_type'] ?? ''])) {
+                       self::storeUnhandledActivity(false, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
+               }
+
                switch ($type) {
                        case 'as:Create':
                                if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
@@ -578,8 +583,7 @@ class Receiver
                                if ($object_data['object_type'] == 'as:tag') {
                                        ActivityPub\Processor::addTag($object_data);
                                } elseif (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
-                                       // Seems to be used by Mastodon to announce that a post is pinned
-                                       self::storeUnhandledActivity(false, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
+                                       ActivityPub\Processor::addToFeaturedCollection($object_data);
                                } elseif ($object_data['object_type'] == '') {
                                        // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
                                } else {
@@ -671,8 +675,7 @@ class Receiver
 
                        case 'as:Block':
                                if (in_array($object_data['object_type'], self::ACCOUNT_TYPES)) {
-                                       // Used by Mastodon to announce that the sender has blocked the account
-                                       self::storeUnhandledActivity(false, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
+                                       ActivityPub\Processor::blockAccount($object_data);
                                } else {
                                        self::storeUnhandledActivity(true, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
                                }
@@ -680,8 +683,7 @@ class Receiver
 
                        case 'as:Remove':
                                if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
-                                       // Seems to be used by Mastodon to remove the pinned status of a post
-                                       self::storeUnhandledActivity(false, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
+                                       ActivityPub\Processor::removeFromFeaturedCollection($object_data);                                      
                                } elseif ($object_data['object_type'] == '') {
                                        // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
                                } else {
@@ -730,6 +732,9 @@ class Receiver
                                } elseif (($object_data['object_type'] == 'as:Accept') &&
                                        in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
                                        ActivityPub\Processor::rejectFollowUser($object_data);
+                               } elseif (($object_data['object_type'] == 'as:Block') &&
+                                       in_array($object_data['object_object_type'], self::ACCOUNT_TYPES)) {
+                                       ActivityPub\Processor::unblockAccount($object_data);
                                } elseif (in_array($object_data['object_type'], array_merge(self::ACTIVITY_TYPES, ['as:Announce'])) &&
                                        in_array($object_data['object_object_type'], array_merge(['as:Tombstone'], self::CONTENT_TYPES))) {
                                        ActivityPub\Processor::undoActivity($object_data);
@@ -745,16 +750,20 @@ class Receiver
                                break;
 
                        case 'as:View':
-                               if (in_array($object_data['object_type'], ['as:Note', 'as:Video'])) {
-                                       // Unhandled Peertube activity
+                               if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
+                                       ActivityPub\Processor::createActivity($object_data, Activity::VIEW);
+                               } elseif ($object_data['object_type'] == '') {
+                                       // The object type couldn't be determined. Most likely we don't have it here. We ignore this activity.
                                } else {
                                        self::storeUnhandledActivity(true, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
                                }
                                break;
 
                        case 'litepub:EmojiReact':
-                               if (in_array($object_data['object_type'], array_merge([''], self::CONTENT_TYPES))) {
-                                       // Unhandled Pleroma activity to react to a post via an emoji
+                               if (in_array($object_data['object_type'], self::CONTENT_TYPES)) {
+                                       ActivityPub\Processor::createActivity($object_data, Activity::EMOJIREACT);
+                               } elseif ($object_data['object_type'] == '') {
+                                       // The object type couldn't be determined. We don't have it and we can't fetch it. We ignore this activity.
                                } else {
                                        self::storeUnhandledActivity(true, $type, $object_data, $activity, $body, $uid, $trust_source, $push, $signer);
                                }
@@ -787,8 +796,18 @@ class Receiver
                        return;
                }
 
-               $tempfile = tempnam(System::getTempPath(), ($unknown  ? 'unknown-' : 'unhandled-') . str_replace(':', '-', $type) . '-' . str_replace(':', '-', $object_data['object_type']) . '-' . str_replace(':', '-', $object_data['object_object_type'] ?? '') . '-');
-               file_put_contents($tempfile, json_encode(['activity' => $activity, 'body' => $body, 'uid' => $uid, 'trust_source' => $trust_source, 'push' => $push, 'signer' => $signer, 'object_data' => $object_data], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE));
+               $file = ($unknown  ? 'unknown-' : 'unhandled-') . str_replace(':', '-', $type) . '-';
+       
+               if (!empty($object_data['object_type'])) {
+                       $file .= str_replace(':', '-', $object_data['object_type']) . '-';
+               }
+
+               if (!empty($object_data['object_object_type'])) {
+                       $file .= str_replace(':', '-', $object_data['object_object_type']) . '-';
+               }
+
+               $tempfile = tempnam(System::getTempPath(), $file);
+               file_put_contents($tempfile, json_encode(['activity' => $activity, 'body' => $body, 'uid' => $uid, 'trust_source' => $trust_source, 'push' => $push, 'signer' => $signer, 'object_data' => $object_data], JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_PRETTY_PRINT));
                Logger::notice('Unknown activity stored', ['type' => $type, 'object_type' => $object_data['object_type'], $object_data['object_object_type'] ?? '', 'file' => $tempfile]);
        }
 
@@ -800,7 +819,7 @@ class Receiver
         *
         * @return int   user id
         */
-       public static function getBestUserForActivity(array $activity)
+       public static function getBestUserForActivity(array $activity): int
        {
                $uid = 0;
                $actor = JsonLD::fetchElement($activity, 'as:actor', '@id') ?? '';
@@ -826,7 +845,8 @@ class Receiver
                return $uid;
        }
 
-       public static function getReceiverURL($activity)
+       // @TODO Missing documentation
+       public static function getReceiverURL(array $activity): array
        {
                $urls = [];
 
@@ -858,9 +878,9 @@ class Receiver
         * @return array with receivers (user id)
         * @throws \Exception
         */
-       private static function getReceivers($activity, $actor, $tags = [], $fetch_unlisted = false)
+       private static function getReceivers(array $activity, string $actor, array $tags = [], bool $fetch_unlisted = false): array
        {
-               $reply = $receivers = [];
+               $reply = $receivers = $profile = [];
 
                // When it is an answer, we inherite the receivers from the parent
                $replyto = JsonLD::fetchElement($activity, 'as:inReplyTo', '@id');
@@ -920,7 +940,7 @@ class Receiver
 
                                // Fetch the receivers for the public and the followers collection
                                if ((($receiver == $followers) || (($receiver == self::PUBLIC_COLLECTION) && !$is_forum)) && !empty($actor)) {
-                                       $receivers = self::getReceiverForActor($actor, $tags, $receivers, $follower_target);
+                                       $receivers = self::getReceiverForActor($actor, $tags, $receivers, $follower_target, $profile);
                                        continue;
                                }
 
@@ -982,33 +1002,46 @@ class Receiver
         * @param array   $tags
         * @param array   $receivers
         * @param integer $target_type
+        * @param array   $profile
         *
         * @return array with receivers (user id)
         * @throws \Exception
         */
-       private static function getReceiverForActor($actor, $tags, $receivers, $target_type)
+       private static function getReceiverForActor(string $actor, array $tags, array $receivers, int $target_type, array $profile): array
        {
                $basecondition = ['rel' => [Contact::SHARING, Contact::FRIEND, Contact::FOLLOWER],
                        'network' => Protocol::FEDERATED, 'archive' => false, 'pending' => false];
 
-               $condition = DBA::mergeConditions($basecondition, ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($actor), 0]);
-               $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
-               while ($contact = DBA::fetch($contacts)) {
-                       if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
-                               $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
+               if (!empty($profile['uri-id'])) {
+                       $condition = DBA::mergeConditions($basecondition, ["`uri-id` = ? AND `uid` != ?", $profile['uri-id'], 0]);
+                       $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
+                       while ($contact = DBA::fetch($contacts)) {
+                               if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
+                                       $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
+                               }
                        }
-               }
-               DBA::close($contacts);
-
-               // The queries are split because of performance issues
-               $condition = DBA::mergeConditions($basecondition, ["`alias` IN (?, ?) AND `uid` != ?", Strings::normaliseLink($actor), $actor, 0]);
-               $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
-               while ($contact = DBA::fetch($contacts)) {
-                       if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
-                               $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
+                       DBA::close($contacts);
+               } else {
+                       // This part will only be called while post update 1426 wasn't finished
+                       $condition = DBA::mergeConditions($basecondition, ["`nurl` = ? AND `uid` != ?", Strings::normaliseLink($actor), 0]);
+                       $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
+                       while ($contact = DBA::fetch($contacts)) {
+                               if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
+                                       $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
+                               }
                        }
+                       DBA::close($contacts);
+
+                       // The queries are split because of performance issues
+                       $condition = DBA::mergeConditions($basecondition, ["`alias` IN (?, ?) AND `uid` != ?", Strings::normaliseLink($actor), $actor, 0]);
+                       $contacts = DBA::select('contact', ['uid', 'rel'], $condition);
+                       while ($contact = DBA::fetch($contacts)) {
+                               if (empty($receivers[$contact['uid']]) && self::isValidReceiverForActor($contact, $tags)) {
+                                       $receivers[$contact['uid']] = ['uid' => $contact['uid'], 'type' => $target_type];
+                               }
+                       }
+                       DBA::close($contacts);
                }
-               DBA::close($contacts);
                return $receivers;
        }
 
@@ -1016,13 +1049,12 @@ class Receiver
         * Tests if the contact is a valid receiver for this actor
         *
         * @param array  $contact
-        * @param string $actor
         * @param array  $tags
         *
         * @return bool with receivers (user id)
         * @throws \Exception
         */
-       private static function isValidReceiverForActor($contact, $tags)
+       private static function isValidReceiverForActor(array $contact, array $tags): bool
        {
                // Are we following the contact? Then this is a valid receiver
                if (in_array($contact['rel'], [Contact::SHARING, Contact::FRIEND])) {
@@ -1055,10 +1087,11 @@ class Receiver
         * @param integer $cid Contact ID
         * @param integer $uid User ID
         * @param string  $url Profile URL
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
-       public static function switchContact($cid, $uid, $url)
+       public static function switchContact(int $cid, int $uid, string $url)
        {
                if (DBA::exists('contact', ['id' => $cid, 'network' => Protocol::ACTIVITYPUB])) {
                        Logger::info('Contact is already ActivityPub', ['id' => $cid, 'uid' => $uid, 'url' => $url]);
@@ -1077,10 +1110,11 @@ class Receiver
        }
 
        /**
-        *
+        * @TODO Fix documentation and type-hints
         *
         * @param $receivers
         * @param $actor
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         * @throws \ImagickException
         */
@@ -1104,14 +1138,14 @@ class Receiver
        }
 
        /**
-        *
+        * @TODO Fix documentation and type-hints
         *
         * @param       $object_data
         * @param array $activity
         *
         * @return mixed
         */
-       private static function addActivityFields($object_data, $activity)
+       private static function addActivityFields($object_data, array $activity)
        {
                if (!empty($activity['published']) && empty($object_data['published'])) {
                        $object_data['published'] = JsonLD::fetchElement($activity, 'as:published', '@value');
@@ -1231,7 +1265,7 @@ class Receiver
         * @param array $languages
         * @return array Languages
         */
-       public static function processLanguages(array $languages)
+       public static function processLanguages(array $languages): array
        {
                if (empty($languages)) {
                        return [];
@@ -1254,7 +1288,7 @@ class Receiver
         *
         * @return array with tags in a simplified format
         */
-       public static function processTags(array $tags)
+       public static function processTags(array $tags): array
        {
                $taglist = [];
 
@@ -1286,7 +1320,7 @@ class Receiver
         * @param array $emojis
         * @return array with emojis in a simplified format
         */
-       private static function processEmojis(array $emojis)
+       private static function processEmojis(array $emojis): array
        {
                $emojilist = [];
 
@@ -1312,7 +1346,7 @@ class Receiver
         *
         * @return array Attachments in a simplified format
         */
-       private static function processAttachments(array $attachments)
+       private static function processAttachments(array $attachments): array
        {
                $attachlist = [];
 
@@ -1422,16 +1456,75 @@ class Receiver
                return $attachlist;
        }
 
+       /**
+        * Convert questions from JSON-LD format into a simplified format
+        *
+        * @param array $object
+        *
+        * @return array Questions in a simplified format
+        */
+       private static function processQuestion(array $object): array
+       {
+               $question = [];
+
+               if (!empty($object['as:oneOf'])) {
+                       $question['multiple'] = false;
+                       $options = JsonLD::fetchElementArray($object, 'as:oneOf') ?? [];
+               } elseif (!empty($object['as:anyOf'])) {
+                       $question['multiple'] = true;
+                       $options = JsonLD::fetchElementArray($object, 'as:anyOf') ?? [];
+               } else {
+                       return [];
+               }
+
+               $closed = JsonLD::fetchElement($object, 'as:closed', '@value');
+               if (!empty($closed)) {
+                       $question['end-time'] = $closed;
+               } else {
+                       $question['end-time'] = JsonLD::fetchElement($object, 'as:endTime', '@value');
+               }
+
+               $question['voters']  = (int)JsonLD::fetchElement($object, 'toot:votersCount', '@value');
+               $question['options'] = [];
+
+               $voters = 0;
+
+               foreach ($options as $option) {
+                       if (JsonLD::fetchElement($option, '@type') != 'as:Note') {
+                               continue;
+                       }
+
+                       $name = JsonLD::fetchElement($option, 'as:name', '@value');
+
+                       if (empty($option['as:replies'])) {
+                               continue;
+                       }
+
+                       $replies = JsonLD::fetchElement($option['as:replies'], 'as:totalItems', '@value');
+
+                       $question['options'][] = ['name' => $name, 'replies' => $replies];
+
+                       $voters += (int)$replies;
+               }
+
+               // For single choice question we can count the number of voters if not provided (like with Misskey)
+               if (empty($question['voters']) && !$question['multiple']) {
+                       $question['voters'] = $voters;
+               }
+
+               return $question;
+       }
+
        /**
         * Fetch the original source or content with the "language" Markdown or HTML
         *
         * @param array $object
         * @param array $object_data
         *
-        * @return array
+        * @return array Object data (?)
         * @throws \Exception
         */
-       private static function getSource($object, $object_data)
+       private static function getSource(array $object, array $object_data): array
        {
                $object_data['source'] = JsonLD::fetchElement($object, 'as:source', 'as:content', 'as:mediaType', 'text/bbcode');
                $object_data['source'] = JsonLD::fetchElement($object_data, 'source', '@value');
@@ -1560,10 +1653,10 @@ class Receiver
         *
         * @param array $object
         *
-        * @return array
+        * @return array|bool Object data or FALSE if $object does not contain @id element
         * @throws \Exception
         */
-       private static function processObject($object)
+       private static function processObject(array $object)
        {
                if (!JsonLD::fetchElement($object, '@id')) {
                        return false;
@@ -1673,7 +1766,11 @@ class Receiver
                        $object_data['alternate-url'] = null;
                }
 
-               $receiverdata = self::getReceivers($object, $object_data['actor'], $object_data['tags'], true);
+               if ($object_data['object_type'] == 'as:Question') {
+                       $object_data['question'] = self::processQuestion($object);
+               }
+
+               $receiverdata = self::getReceivers($object, $object_data['actor'] ?? '', $object_data['tags'], true);
                $receivers = $reception_types = [];
                foreach ($receiverdata as $key => $data) {
                        $receivers[$key] = $data['uid'];