]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/ActivityPub/Transmitter.php
Fix PHPDoc comments project-wide
[friendica.git] / src / Protocol / ActivityPub / Transmitter.php
index 04631aa2fbf3c27f56e6599b159719aa581f115c..5136bc72c1b8231aa75b8bb0c6e7a6bed5307c24 100644 (file)
@@ -42,10 +42,11 @@ class Transmitter
        /**
         * collects the lost of followers of the given owner
         *
-        * @param array $owner Owner array
-        * @param integer $page Page number
+        * @param array   $owner Owner array
+        * @param integer $page  Page number
         *
         * @return array of owners
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function getFollowers($owner, $page = null)
        {
@@ -89,10 +90,11 @@ class Transmitter
        /**
         * Create list of following contacts
         *
-        * @param array $owner Owner array
-        * @param integer $page Page numbe
+        * @param array   $owner Owner array
+        * @param integer $page  Page numbe
         *
         * @return array of following contacts
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function getFollowing($owner, $page = null)
        {
@@ -136,10 +138,12 @@ class Transmitter
        /**
         * Public posts for the given owner
         *
-        * @param array $owner Owner array
-        * @param integer $page Page numbe
+        * @param array   $owner Owner array
+        * @param integer $page  Page numbe
         *
         * @return array of posts
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function getOutbox($owner, $page = null)
        {
@@ -186,6 +190,7 @@ class Transmitter
         *
         * @param integer $uid User ID
         * @return array with profile data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function getProfile($uid)
        {
@@ -246,6 +251,8 @@ class Transmitter
         * @param array $item
         *
         * @return array with permissions
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        private static function fetchPermissionBlockFromConversation($item)
        {
@@ -295,13 +302,30 @@ class Transmitter
        /**
         * Creates an array of permissions from an item thread
         *
-        * @param array $item
+        * @param array   $item
         * @param boolean $blindcopy
+        * @param boolean $last_id
         *
         * @return array with permission data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
-       private static function createPermissionBlockForItem($item, $blindcopy)
+       private static function createPermissionBlockForItem($item, $blindcopy, $last_id = 0)
        {
+               if ($last_id == 0) {
+                       $last_id = $item['id'];
+               }
+
+               $always_bcc = false;
+
+               // Check if we should always deliver our stuff via BCC
+               if (!empty($item['uid'])) {
+                       $profile = Profile::getByUID($item['uid']);
+                       if (!empty($profile)) {
+                               $always_bcc = $profile['hide-friends'];
+                       }
+               }
+
                // Will be activated in a later step
                // $networks = [Protocol::ACTIVITYPUB, Protocol::DFRN, Protocol::DIASPORA, Protocol::OSTATUS];
 
@@ -344,11 +368,13 @@ class Transmitter
                        }
 
                        foreach ($receiver_list as $receiver) {
-                               $contact = DBA::selectFirst('contact', ['url'], ['id' => $receiver, 'network' => $networks]);
+                               $contact = DBA::selectFirst('contact', ['url', 'hidden'], ['id' => $receiver, 'network' => $networks]);
                                if (DBA::isResult($contact) && !empty($profile = APContact::getByURL($contact['url'], false))) {
-                                       // BCC is currently deactivated, due to Pleroma and Mastodon not reacting like expected
-                                       // $data['bcc'][] = $profile['url'];
-                                       $data['cc'][] = $profile['url'];
+                                       if ($contact['hidden'] || $always_bcc) {
+                                               $data['bcc'][] = $profile['url'];
+                                       } else {
+                                               $data['cc'][] = $profile['url'];
+                                       }
                                }
                        }
                }
@@ -356,7 +382,7 @@ class Transmitter
                $parents = Item::select(['id', 'author-link', 'owner-link', 'gravity', 'uri'], ['parent' => $item['parent']]);
                while ($parent = Item::fetch($parents)) {
                        // Don't include data from future posts
-                       if ($parent['id'] >= $item['id']) {
+                       if ($parent['id'] >= $last_id) {
                                continue;
                        }
 
@@ -424,10 +450,12 @@ class Transmitter
        /**
         * Fetches a list of inboxes of followers of a given user
         *
-        * @param integer $uid User ID
+        * @param integer $uid      User ID
         * @param boolean $personal fetch personal inboxes
         *
         * @return array of follower inboxes
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function fetchTargetInboxesforUser($uid, $personal = false)
        {
@@ -469,15 +497,18 @@ class Transmitter
        /**
         * Fetches an array of inboxes for the given item and user
         *
-        * @param array $item
-        * @param integer $uid User ID
+        * @param array   $item
+        * @param integer $uid      User ID
         * @param boolean $personal fetch personal inboxes
+        * @param integer $last_id Last item id for adding receivers
         *
         * @return array with inboxes
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
-       public static function fetchTargetInboxes($item, $uid, $personal = false)
+       public static function fetchTargetInboxes($item, $uid, $personal = false, $last_id = 0)
        {
-               $permissions = self::createPermissionBlockForItem($item, true);
+               $permissions = self::createPermissionBlockForItem($item, true, $last_id);
                if (empty($permissions)) {
                        return [];
                }
@@ -527,10 +558,20 @@ class Transmitter
         * @param array $item
         *
         * @return string with activity type
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        private static function getTypeOfItem($item)
        {
-               if (!empty(Diaspora::isReshare($item['body'], false))) {
+               $reshared = false;
+
+               // Only check for a reshare, if it is a real reshare and no quoted reshare
+               if (strpos($item['body'], "[share") === 0) {
+                       $announce = api_share_as_retweet($item);
+                       $reshared = !empty($announce['plink']);
+               }
+
+               if ($reshared) {
                        $type = 'Announce';
                } elseif ($item['verb'] == ACTIVITY_POST) {
                        if ($item['created'] == $item['edited']) {
@@ -559,9 +600,10 @@ class Transmitter
         * Creates the activity or fetches it from the cache
         *
         * @param integer $item_id
-        * @param boolean $force   Force new cache entry
+        * @param boolean $force Force new cache entry
         *
         * @return array with the activity
+        * @throws \Exception
         */
        public static function createCachedActivityFromItem($item_id, $force = false)
        {
@@ -587,6 +629,7 @@ class Transmitter
         * @param boolean $object_mode Is the activity item is used inside another object?
         *
         * @return array of activity
+        * @throws \Exception
         */
        public static function createActivityFromItem($item_id, $object_mode = false)
        {
@@ -643,9 +686,15 @@ class Transmitter
                        $data['object'] = $item['thr-parent'];
                }
 
-               $owner = User::getOwnerDataById($item['contact-uid']);
+               if (!empty($item['contact-uid'])) {
+                       $uid = $item['contact-uid'];
+               } else {
+                       $uid = $item['uid'];
+               }
+
+               $owner = User::getOwnerDataById($uid);
 
-               if (!$object_mode) {
+               if (!$object_mode && !empty($owner)) {
                        return LDSignature::sign($data, $owner);
                } else {
                        return $data;
@@ -660,6 +709,8 @@ class Transmitter
         * @param integer $item_id
         *
         * @return array with the object data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function createObjectFromItemID($item_id)
        {
@@ -715,6 +766,7 @@ class Transmitter
         * @param array $item
         *
         * @return array of tags
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function createTagList($item)
        {
@@ -723,7 +775,8 @@ class Transmitter
                $terms = Term::tagArrayFromItemId($item['id']);
                foreach ($terms as $term) {
                        if ($term['type'] == TERM_HASHTAG) {
-                               $tags[] = ['type' => 'Hashtag', 'href' => $term['url'], 'name' => '#' . $term['term']];
+                               $url = System::baseUrl() . '/search?tag=' . urlencode($term['term']);
+                               $tags[] = ['type' => 'Hashtag', 'href' => $url, 'name' => '#' . $term['term']];
                        } elseif ($term['type'] == TERM_MENTION) {
                                $contact = Contact::getDetailsByURL($term['url']);
                                if (!empty($contact['addr'])) {
@@ -741,10 +794,11 @@ class Transmitter
        /**
         * Adds attachment data to the JSON document
         *
-        * @param array $item Data of the item that is to be posted
-        * @param text $type Object type
+        * @param array  $item Data of the item that is to be posted
+        * @param string $type Object type
         *
         * @return array with attachment data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function createAttachmentList($item, $type)
        {
@@ -793,11 +847,12 @@ class Transmitter
                return $attachments;
        }
 
-        /**
+       /**
         * @brief Callback function to replace a Friendica style mention in a mention that is used on AP
         *
         * @param array $match Matching values for the callback
         * @return string Replaced mention
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        private static function mentionCallback($match)
        {
@@ -837,6 +892,7 @@ class Transmitter
         * @param array $item
         *
         * @return string with context url
+        * @throws \Exception
         */
        private static function fetchContextURLForItem($item)
        {
@@ -857,6 +913,7 @@ class Transmitter
         * @param integer $item_id
         *
         * @return boolean
+        * @throws \Exception
         */
        private static function isSensitive($item_id)
        {
@@ -870,6 +927,7 @@ class Transmitter
         * @param array $item
         *
         * @return array with the event data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function createEvent($item)
        {
@@ -896,6 +954,8 @@ class Transmitter
         * @param array $item
         *
         * @return array with the object data
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function createNote($item)
        {
@@ -986,6 +1046,8 @@ class Transmitter
         * @param array $item
         *
         * @return string with announced object url
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function createAnnounce($item)
        {
@@ -994,7 +1056,17 @@ class Transmitter
                        return self::createNote($item);
                }
 
-               return $announce['plink'];
+               // Fetch the original id of the object
+               $activity = ActivityPub::fetchContent($announce['plink'], $item['uid']);
+               if (!empty($activity)) {
+                       $ldactivity = JsonLD::compact($activity);
+                       $id = JsonLD::fetchElement($ldactivity, '@id');
+                       if (!empty($id)) {
+                               return $id;
+                       }
+               }
+
+               return self::createNote($item);
        }
 
        /**
@@ -1019,11 +1091,12 @@ class Transmitter
        /**
         * Transmits a contact suggestion to a given inbox
         *
-        * @param integer $uid User ID
-        * @param string $inbox Target inbox
+        * @param integer $uid           User ID
+        * @param string  $inbox         Target inbox
         * @param integer $suggestion_id Suggestion ID
         *
         * @return boolean was the transmission successful?
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function sendContactSuggestion($uid, $inbox, $suggestion_id)
        {
@@ -1050,10 +1123,11 @@ class Transmitter
        /**
         * Transmits a profile relocation to a given inbox
         *
-        * @param integer $uid User ID
-        * @param string $inbox Target inbox
+        * @param integer $uid   User ID
+        * @param string  $inbox Target inbox
         *
         * @return boolean was the transmission successful?
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function sendProfileRelocation($uid, $inbox)
        {
@@ -1078,10 +1152,11 @@ class Transmitter
        /**
         * Transmits a profile deletion to a given inbox
         *
-        * @param integer $uid User ID
-        * @param string $inbox Target inbox
+        * @param integer $uid   User ID
+        * @param string  $inbox Target inbox
         *
         * @return boolean was the transmission successful?
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function sendProfileDeletion($uid, $inbox)
        {
@@ -1106,10 +1181,12 @@ class Transmitter
        /**
         * Transmits a profile change to a given inbox
         *
-        * @param integer $uid User ID
-        * @param string $inbox Target inbox
+        * @param integer $uid   User ID
+        * @param string  $inbox Target inbox
         *
         * @return boolean was the transmission successful?
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function sendProfileUpdate($uid, $inbox)
        {
@@ -1135,10 +1212,12 @@ class Transmitter
        /**
         * Transmits a given activity to a target
         *
-        * @param array $activity
-        * @param string $target Target profile
-        * @param integer $uid User ID
-        * @param string $id activity id
+        * @param array   $activity
+        * @param string  $target Target profile
+        * @param integer $uid    User ID
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        * @throws \Exception
         */
        public static function sendActivity($activity, $target, $uid, $id = '')
        {
@@ -1167,9 +1246,11 @@ class Transmitter
        /**
         * Transmit a message that the contact request had been accepted
         *
-        * @param string $target Target profile
-        * @param $id
-        * @param integer $uid User ID
+        * @param string  $target Target profile
+        * @param         $id
+        * @param integer $uid    User ID
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function sendContactAccept($target, $id, $uid)
        {
@@ -1195,9 +1276,11 @@ class Transmitter
        /**
         * Reject a contact request or terminates the contact relation
         *
-        * @param string $target Target profile
-        * @param $id
-        * @param integer $uid User ID
+        * @param string  $target Target profile
+        * @param         $id
+        * @param integer $uid    User ID
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
         */
        public static function sendContactReject($target, $id, $uid)
        {
@@ -1223,9 +1306,11 @@ class Transmitter
        /**
         * Transmits a message that we don't want to follow this contact anymore
         *
-        * @param string $target Target profile
-        * @param integer $cid Contact ID of target
-        * @param integer $uid User ID
+        * @param string  $target Target profile
+        * @param integer $uid    User ID
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @throws \ImagickException
+        * @throws \Exception
         */
        public static function sendContactUndo($target, $cid, $uid)
        {