]> git.mxchange.org Git - friendica.git/blobdiff - src/Protocol/ActivityPub/Transmitter.php
Merge pull request #5899 from annando/avoid-flooding
[friendica.git] / src / Protocol / ActivityPub / Transmitter.php
index c3bc2eeb74ba466316010f82e4da772697852226..96c069e589c94d503845e77cff7dc4d44809eceb 100644 (file)
@@ -6,7 +6,6 @@ namespace Friendica\Protocol\ActivityPub;
 
 use Friendica\Database\DBA;
 use Friendica\Core\System;
-use Friendica\BaseObject;
 use Friendica\Util\HTTPSignature;
 use Friendica\Core\Protocol;
 use Friendica\Model\Conversation;
@@ -19,28 +18,35 @@ use Friendica\Util\DateTimeFormat;
 use Friendica\Content\Text\BBCode;
 use Friendica\Util\JsonLD;
 use Friendica\Util\LDSignature;
-use Friendica\Protocol\ActivityPub;
 use Friendica\Model\Profile;
+use Friendica\Core\Config;
+use Friendica\Object\Image;
+use Friendica\Protocol\ActivityPub;
+use Friendica\Core\Cache;
 
 /**
  * @brief ActivityPub Transmitter Protocol class
  *
  * To-Do:
+ *
+ * Missing object fields:
+ * - service (App)
+ * - location
+ *
+ * Missing object types:
  * - Event
  *
- * Complicated:
+ * Complicated object types:
  * - Announce
  * - Undo Announce
  *
  * General:
- * - Attachments
- * - nsfw (sensitive)
  * - Queueing unsucessful deliveries
  */
 class Transmitter
 {
        /**
-        * @brief collects the lost of followers of the given owner
+        * collects the lost of followers of the given owner
         *
         * @param array $owner Owner array
         * @param integer $page Page number
@@ -87,7 +93,7 @@ class Transmitter
        }
 
        /**
-        * @brief Create list of following contacts
+        * Create list of following contacts
         *
         * @param array $owner Owner array
         * @param integer $page Page numbe
@@ -134,7 +140,7 @@ class Transmitter
        }
 
        /**
-        * @brief Public posts for the given owner
+        * Public posts for the given owner
         *
         * @param array $owner Owner array
         * @param integer $page Page numbe
@@ -185,9 +191,9 @@ class Transmitter
         * Return the ActivityPub profile of the given user
         *
         * @param integer $uid User ID
-        * @return profile array
+        * @return array with profile data
         */
-       public static function profile($uid)
+       public static function getProfile($uid)
        {
                $condition = ['uid' => $uid, 'blocked' => false, 'account_expired' => false,
                        'account_removed' => false, 'verified' => true];
@@ -203,12 +209,17 @@ class Transmitter
                        return [];
                }
 
-               $fields = ['name', 'url', 'location', 'about', 'avatar'];
+               $fields = ['name', 'url', 'location', 'about', 'avatar', 'photo'];
                $contact = DBA::selectFirst('contact', $fields, ['uid' => $uid, 'self' => true]);
                if (!DBA::isResult($contact)) {
                        return [];
                }
 
+               // On old installations and never changed contacts this might not be filled
+               if (empty($contact['avatar'])) {
+                       $contact['avatar'] = $contact['photo'];
+               }
+
                $data = ['@context' => ActivityPub::CONTEXT];
                $data['id'] = $contact['url'];
                $data['diaspora:guid'] = $user['guid'];
@@ -236,7 +247,7 @@ class Transmitter
        }
 
        /**
-        * @brief Returns an array with permissions of a given item array
+        * Returns an array with permissions of a given item array
         *
         * @param array $item
         *
@@ -289,11 +300,11 @@ class Transmitter
        }
 
        /**
-        * @brief Creates an array of permissions from an item thread
+        * Creates an array of permissions from an item thread
         *
         * @param array $item
         *
-        * @return permission array
+        * @return array with permission data
         */
        private static function createPermissionBlockForItem($item)
        {
@@ -377,7 +388,7 @@ class Transmitter
        }
 
        /**
-        * @brief Fetches a list of inboxes of followers of a given user
+        * Fetches a list of inboxes of followers of a given user
         *
         * @param integer $uid User ID
         *
@@ -404,7 +415,7 @@ class Transmitter
        }
 
        /**
-        * @brief Fetches an array of inboxes for the given item and user
+        * Fetches an array of inboxes for the given item and user
         *
         * @param array $item
         * @param integer $uid User ID
@@ -448,11 +459,11 @@ class Transmitter
        }
 
        /**
-        * @brief Returns the activity type of a given item
+        * Returns the activity type of a given item
         *
         * @param array $item
         *
-        * @return activity type
+        * @return string with activity type
         */
        private static function getTypeOfItem($item)
        {
@@ -480,7 +491,28 @@ class Transmitter
        }
 
        /**
-        * @brief Creates an activity array for a given item id
+        * Creates the activity or fetches it from the cache
+        *
+        * @param integer $item_id
+        *
+        * @return array with the activity
+        */
+       public static function createCachedActivityFromItem($item_id)
+       {
+               $cachekey = 'APDelivery:createActivity:' . $item_id;
+               $data = Cache::get($cachekey);
+               if (!is_null($data)) {
+                       return $data;
+               }
+
+               $data = ActivityPub\Transmitter::createActivityFromItem($item_id);
+
+               Cache::set($cachekey, $data, CACHE_QUARTER_HOUR);
+               return $data;
+       }
+
+       /**
+        * Creates an activity array for a given item id
         *
         * @param integer $item_id
         * @param boolean $object_mode Is the activity item is used inside another object?
@@ -520,15 +552,9 @@ class Transmitter
 
                $data['id'] = $item['uri'] . '#' . $type;
                $data['type'] = $type;
-               $data['actor'] = $item['author-link'];
-
-               $data['published'] = DateTimeFormat::utc($item["created"]."+00:00", DateTimeFormat::ATOM);
+               $data['actor'] = $item['owner-link'];
 
-               if ($item["created"] != $item["edited"]) {
-                       $data['updated'] = DateTimeFormat::utc($item["edited"]."+00:00", DateTimeFormat::ATOM);
-               }
-
-               $data['context'] = self::fetchContextURLForItem($item);
+               $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
 
                $data = array_merge($data, self::createPermissionBlockForItem($item));
 
@@ -537,6 +563,7 @@ class Transmitter
                } elseif ($data['type'] == 'Undo') {
                        $data['object'] = self::createActivityFromItem($item_id, true);
                } else {
+                       $data['diaspora:guid'] = $item['guid'];
                        $data['object'] = $item['thr-parent'];
                }
 
@@ -547,14 +574,16 @@ class Transmitter
                } else {
                        return $data;
                }
+
+               /// @todo Create "conversation" entry
        }
 
        /**
-        * @brief Creates an object array for a given item id
+        * Creates an object array for a given item id
         *
         * @param integer $item_id
         *
-        * @return object array
+        * @return array with the object data
         */
        public static function createObjectFromItemID($item_id)
        {
@@ -571,7 +600,7 @@ class Transmitter
        }
 
        /**
-        * @brief Returns a tag array for a given item array
+        * Returns a tag array for a given item array
         *
         * @param array $item
         *
@@ -581,22 +610,99 @@ class Transmitter
        {
                $tags = [];
 
-               $terms = Term::tagArrayFromItemId($item['id'], TERM_MENTION);
+               $terms = Term::tagArrayFromItemId($item['id']);
                foreach ($terms as $term) {
-                       $contact = Contact::getDetailsByURL($term['url']);
-                       if (!empty($contact['addr'])) {
-                               $mention = '@' . $contact['addr'];
-                       } else {
-                               $mention = '@' . $term['url'];
-                       }
+                       if ($term['type'] == TERM_HASHTAG) {
+                               $tags[] = ['type' => 'Hashtag', 'href' => $term['url'], 'name' => '#' . $term['term']];
+                       } elseif ($term['type'] == TERM_MENTION) {
+                               $contact = Contact::getDetailsByURL($term['url']);
+                               if (!empty($contact['addr'])) {
+                                       $mention = '@' . $contact['addr'];
+                               } else {
+                                       $mention = '@' . $term['url'];
+                               }
 
-                       $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
+                               $tags[] = ['type' => 'Mention', 'href' => $term['url'], 'name' => $mention];
+                       }
                }
                return $tags;
        }
 
        /**
-        * @brief Fetches the "context" value for a givem item array from the "conversation" table
+        * Adds attachment data to the JSON document
+        *
+        * @param array $item Data of the item that is to be posted
+        * @param text $type Object type
+        *
+        * @return array with attachment data
+        */
+       private static function createAttachmentList($item, $type)
+       {
+               $attachments = [];
+
+               $arr = explode('[/attach],', $item['attach']);
+               if (count($arr)) {
+                       foreach ($arr as $r) {
+                               $matches = false;
+                               $cnt = preg_match('|\[attach\]href=\"(.*?)\" length=\"(.*?)\" type=\"(.*?)\" title=\"(.*?)\"|', $r, $matches);
+                               if ($cnt) {
+                                       $attributes = ['type' => 'Document',
+                                                       'mediaType' => $matches[3],
+                                                       'url' => $matches[1],
+                                                       'name' => null];
+
+                                       if (trim($matches[4]) != '') {
+                                               $attributes['name'] = trim($matches[4]);
+                                       }
+
+                                       $attachments[] = $attributes;
+                               }
+                       }
+               }
+
+               if ($type != 'Note') {
+                       return $attachments;
+               }
+
+               // Simplify image codes
+               $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $item['body']);
+
+               // Grab all pictures and create attachments out of them
+               if (preg_match_all("/\[img\]([^\[\]]*)\[\/img\]/Usi", $body, $pictures)) {
+                       foreach ($pictures[1] as $picture) {
+                               $imgdata = Image::getInfoFromURL($picture);
+                               if ($imgdata) {
+                                       $attachments[] = ['type' => 'Document',
+                                               'mediaType' => $imgdata['mime'],
+                                               'url' => $picture,
+                                               'name' => null];
+                               }
+                       }
+               }
+
+               return $attachments;
+       }
+
+       /**
+        * Remove image elements and replaces them with links to the image
+        *
+        * @param string $body
+        *
+        * @return string with replaced elements
+        */
+       private static function removePictures($body)
+       {
+               // Simplify image codes
+               $body = preg_replace("/\[img\=([0-9]*)x([0-9]*)\](.*?)\[\/img\]/ism", '[img]$3[/img]', $body);
+
+               $body = preg_replace("/\[url=([^\[\]]*)\]\[img\](.*)\[\/img\]\[\/url\]/Usi", '[url]$1[/url]', $body);
+               $body = preg_replace("/\[img\]([^\[\]]*)\[\/img\]/Usi", '[url]$1[/url]', $body);
+
+               return $body;
+       }
+
+       /**
+        * Fetches the "context" value for a givem item array from the "conversation" table
         *
         * @param array $item
         *
@@ -610,19 +716,32 @@ class Transmitter
                } elseif (DBA::isResult($conversation) && !empty($conversation['conversation-uri'])) {
                        $context_uri = $conversation['conversation-uri'];
                } else {
-                       $context_uri = str_replace('/objects/', '/context/', $item['parent-uri']);
+                       $context_uri = $item['parent-uri'] . '#context';
                }
                return $context_uri;
        }
 
        /**
-        * @brief Creates a note/article object array
+        * Returns if the post contains sensitive content ("nsfw")
+        *
+        * @param integer $item_id
+        *
+        * @return boolean
+        */
+       private static function isSensitive($item_id)
+       {
+               $condition = ['otype' => TERM_OBJ_POST, 'oid' => $item_id, 'type' => TERM_HASHTAG, 'term' => 'nsfw'];
+               return DBA::exists('term', $condition);
+       }
+
+       /**
+        * Creates a note/article object array
         *
         * @param array $item
         *
-        * @return object array
+        * @return array with the object data
         */
-       private static function createNote($item)
+       public static function createNote($item)
        {
                if (!empty($item['title'])) {
                        $type = 'Article';
@@ -651,30 +770,35 @@ class Transmitter
                }
 
                $data['diaspora:guid'] = $item['guid'];
-               $data['published'] = DateTimeFormat::utc($item["created"]."+00:00", DateTimeFormat::ATOM);
+               $data['published'] = DateTimeFormat::utc($item['created'] . '+00:00', DateTimeFormat::ATOM);
 
-               if ($item["created"] != $item["edited"]) {
-                       $data['updated'] = DateTimeFormat::utc($item["edited"]."+00:00", DateTimeFormat::ATOM);
+               if ($item['created'] != $item['edited']) {
+                       $data['updated'] = DateTimeFormat::utc($item['edited'] . '+00:00', DateTimeFormat::ATOM);
                }
 
                $data['url'] = $item['plink'];
                $data['attributedTo'] = $item['author-link'];
-               $data['actor'] = $item['author-link'];
-               $data['sensitive'] = false; // - Query NSFW
+               $data['sensitive'] = self::isSensitive($item['id']);
                $data['context'] = self::fetchContextURLForItem($item);
 
                if (!empty($item['title'])) {
-                       $data['name'] = BBCode::convert($item['title'], false, 7);
+                       $data['name'] = BBCode::toPlaintext($item['title'], false);
                }
 
-               $data['content'] = BBCode::convert($item['body'], false, 7);
+               $body = $item['body'];
+
+               if ($type == 'Note') {
+                       $body = self::removePictures($body);
+               }
+
+               $data['content'] = BBCode::convert($body, false, 7);
                $data['source'] = ['content' => $item['body'], 'mediaType' => "text/bbcode"];
 
                if (!empty($item['signed_text']) && ($item['uri'] != $item['thr-parent'])) {
                        $data['diaspora:comment'] = $item['signed_text'];
                }
 
-               $data['attachment'] = []; // @ToDo
+               $data['attachment'] = self::createAttachmentList($item, $type);
                $data['tag'] = self::createTagList($item);
                $data = array_merge($data, self::createPermissionBlockForItem($item));
 
@@ -682,7 +806,37 @@ class Transmitter
        }
 
        /**
-        * @brief Transmits a profile deletion to a given inbox
+        * Transmits a contact suggestion to a given inbox
+        *
+        * @param integer $uid User ID
+        * @param string $inbox Target inbox
+        * @param integer $suggestion_id Suggestion ID
+        */
+       public static function sendContactSuggestion($uid, $inbox, $suggestion_id)
+       {
+               $owner = User::getOwnerDataById($uid);
+               $profile = APContact::getByURL($owner['url']);
+
+               $suggestion = DBA::selectFirst('fsuggest', ['url', 'note', 'created'], ['id' => $suggestion_id]);
+
+               $data = ['@context' => 'https://www.w3.org/ns/activitystreams',
+                       'id' => System::baseUrl() . '/activity/' . System::createGUID(),
+                       'type' => 'Announce',
+                       'actor' => $owner['url'],
+                       'object' => $suggestion['url'],
+                       'content' => $suggestion['note'],
+                       'published' => DateTimeFormat::utc($suggestion['created'] . '+00:00', DateTimeFormat::ATOM),
+                       'to' => [ActivityPub::PUBLIC_COLLECTION],
+                       'cc' => []];
+
+               $signed = LDSignature::sign($data, $owner);
+
+               logger('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', LOGGER_DEBUG);
+               HTTPSignature::transmit($signed, $inbox, $uid);
+       }
+
+       /**
+        * Transmits a profile deletion to a given inbox
         *
         * @param integer $uid User ID
         * @param string $inbox Target inbox
@@ -703,12 +857,12 @@ class Transmitter
 
                $signed = LDSignature::sign($data, $owner);
 
-               logger('Deliver profile deletion for user ' . $uid . ' to ' . $inbox .' via ActivityPub', LOGGER_DEBUG);
+               logger('Deliver profile deletion for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', LOGGER_DEBUG);
                HTTPSignature::transmit($signed, $inbox, $uid);
        }
 
        /**
-        * @brief Transmits a profile change to a given inbox
+        * Transmits a profile change to a given inbox
         *
         * @param integer $uid User ID
         * @param string $inbox Target inbox
@@ -722,19 +876,19 @@ class Transmitter
                        'id' => System::baseUrl() . '/activity/' . System::createGUID(),
                        'type' => 'Update',
                        'actor' => $owner['url'],
-                       'object' => self::profile($uid),
+                       'object' => self::getProfile($uid),
                        'published' => DateTimeFormat::utcNow(DateTimeFormat::ATOM),
                        'to' => [$profile['followers']],
                        'cc' => []];
 
                $signed = LDSignature::sign($data, $owner);
 
-               logger('Deliver profile update for user ' . $uid . ' to ' . $inbox .' via ActivityPub', LOGGER_DEBUG);
+               logger('Deliver profile update for user ' . $uid . ' to ' . $inbox . ' via ActivityPub', LOGGER_DEBUG);
                HTTPSignature::transmit($signed, $inbox, $uid);
        }
 
        /**
-        * @brief Transmits a given activity to a target
+        * Transmits a given activity to a target
         *
         * @param array $activity
         * @param string $target Target profile
@@ -760,7 +914,7 @@ class Transmitter
        }
 
        /**
-        * @brief Transmit a message that the contact request had been accepted
+        * Transmit a message that the contact request had been accepted
         *
         * @param string $target Target profile
         * @param $id
@@ -787,7 +941,7 @@ class Transmitter
        }
 
        /**
-        * @brief 
+        * Reject a contact request or terminates the contact relation
         *
         * @param string $target Target profile
         * @param $id
@@ -814,7 +968,7 @@ class Transmitter
        }
 
        /**
-        * @brief 
+        * Transmits a message that we don't want to follow this contact anymore
         *
         * @param string $target Target profile
         * @param integer $uid User ID