]> git.mxchange.org Git - friendica.git/blobdiff - src/Model/Item.php
Funkwhale context file moved
[friendica.git] / src / Model / Item.php
index 51f879d4d00992aa186c18fb9f38ae4fd0e2c43e..3ae23412e6e20689b5745f49b880740ed3e9e294 100644 (file)
@@ -83,7 +83,7 @@ class Item
        // Field list that is used to display the items
        const DISPLAY_FIELDLIST = [
                'uid', 'id', 'parent', 'guid', 'network', 'gravity',
-               'uri-id', 'uri', 'thr-parent-id', 'thr-parent', 'parent-uri-id', 'parent-uri',
+               'uri-id', 'uri', 'thr-parent-id', 'thr-parent', 'parent-uri-id', 'parent-uri', 'conversation',
                'commented', 'created', 'edited', 'received', 'verb', 'object-type', 'postopts', 'plink',
                'wall', 'private', 'starred', 'origin', 'parent-origin', 'title', 'body', 'language',
                'content-warning', 'location', 'coord', 'app', 'rendered-hash', 'rendered-html', 'object',
@@ -96,14 +96,14 @@ class Item
                'event-created', 'event-edited', 'event-start', 'event-finish',
                'event-summary', 'event-desc', 'event-location', 'event-type',
                'event-nofinish', 'event-ignore', 'event-id',
-               "question-id", "question-multiple", "question-voters", "question-end-time",
-               "has-categories", "has-media",
+               'question-id', 'question-multiple', 'question-voters', 'question-end-time',
+               'has-categories', 'has-media',
                'delivery_queue_count', 'delivery_queue_done', 'delivery_queue_failed'
        ];
 
        // Field list that is used to deliver items via the protocols
        const DELIVER_FIELDLIST = ['uid', 'id', 'parent', 'uri-id', 'uri', 'thr-parent', 'parent-uri', 'guid',
-                       'parent-guid', 'received', 'created', 'edited', 'verb', 'object-type', 'object', 'target',
+                       'parent-guid', 'conversation', 'received', 'created', 'edited', 'verb', 'object-type', 'object', 'target',
                        'private', 'title', 'body', 'raw-body', 'location', 'coord', 'app',
                        'inform', 'deleted', 'extid', 'post-type', 'post-reason', 'gravity',
                        'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
@@ -116,7 +116,7 @@ class Item
 
        // All fields in the item table
        const ITEM_FIELDLIST = ['id', 'uid', 'parent', 'uri', 'parent-uri', 'thr-parent',
-                       'guid', 'uri-id', 'parent-uri-id', 'thr-parent-id', 'vid',
+                       'guid', 'uri-id', 'parent-uri-id', 'thr-parent-id', 'conversation', 'vid',
                        'contact-id', 'wall', 'gravity', 'extid', 'psid',
                        'created', 'edited', 'commented', 'received', 'changed', 'verb',
                        'postopts', 'plink', 'resource-id', 'event-id', 'inform',
@@ -226,7 +226,7 @@ class Item
 
                foreach ($notify_items as $notify_item) {
                        $post = Post::selectFirst(['uri-id', 'uid'], ['id' => $notify_item]);
-                       Worker::add(PRIORITY_HIGH, "Notifier", Delivery::POST, (int)$post['uri-id'], (int)$post['uid']);
+                       Worker::add(PRIORITY_HIGH, 'Notifier', Delivery::POST, (int)$post['uri-id'], (int)$post['uid']);
                }
 
                return $rows;
@@ -237,9 +237,10 @@ class Item
         *
         * @param array   $condition The condition for finding the item entries
         * @param integer $priority  Priority for the notification
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function markForDeletion($condition, $priority = PRIORITY_HIGH)
+       public static function markForDeletion(array $condition, int $priority = PRIORITY_HIGH)
        {
                $items = Post::select(['id'], $condition);
                while ($item = Post::fetch($items)) {
@@ -253,6 +254,7 @@ class Item
         *
         * @param array   $condition The condition for finding the item entries
         * @param integer $uid       User who wants to delete this item
+        * @return void
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
        public static function deleteForUser(array $condition, int $uid)
@@ -282,11 +284,10 @@ class Item
         *
         * @param integer $item_id
         * @param integer $priority Priority for the notification
-        *
         * @return boolean success
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function markForDeletionById($item_id, $priority = PRIORITY_HIGH)
+       public static function markForDeletionById(int $item_id, int $priority = PRIORITY_HIGH): bool
        {
                Logger::info('Mark item for deletion by id', ['id' => $item_id, 'callstack' => System::callstack()]);
                // locate item to be deleted
@@ -331,7 +332,7 @@ class Item
                // If item has attachments, drop them
                $attachments = Post\Media::getByURIId($item['uri-id'], [Post\Media::DOCUMENT]);
                foreach($attachments as $attachment) {
-                       if (preg_match("|attach/(\d+)|", $attachment['url'], $matches)) {
+                       if (preg_match('|attach/(\d+)|', $attachment['url'], $matches)) {
                                Attach::delete(['id' => $matches[1], 'uid' => $item['uid']]);
                        }
                }
@@ -360,7 +361,7 @@ class Item
 
                        // send the notification upstream/downstream
                        if ($priority) {
-                               Worker::add(['priority' => $priority, 'dont_fork' => true], "Notifier", Delivery::DELETION, (int)$item['uri-id'], (int)$item['uid']);
+                               Worker::add(['priority' => $priority, 'dont_fork' => true], 'Notifier', Delivery::DELETION, (int)$item['uri-id'], (int)$item['uid']);
                        }
                } elseif ($item['uid'] != 0) {
                        Post\User::update($item['uri-id'], $item['uid'], ['hidden' => true]);
@@ -372,7 +373,14 @@ class Item
                return true;
        }
 
-       public static function guid($item, $notify)
+       /**
+        * Get guid from given item record
+        *
+        * @param array $item Item record
+        * @param bool Whether to notify (?)
+        * @return string Guid
+        */
+       public static function guid(array $item, bool $notify): string
        {
                if (!empty($item['guid'])) {
                        return trim($item['guid']);
@@ -425,7 +433,13 @@ class Item
                return $guid;
        }
 
-       private static function contactId($item)
+       /**
+        * Returns contact id from given item record
+        *
+        * @param array $item Item record
+        * @return int Contact id
+        */
+       private static function contactId(array $item): int
        {
                if (!empty($item['contact-id']) && DBA::exists('contact', ['self' => true, 'id' => $item['contact-id']])) {
                        return $item['contact-id'];
@@ -451,17 +465,17 @@ class Item
         * @param array $item The item fields that are to be inserted
         * @throws \Exception
         */
-       private static function spool($orig_item)
+       private static function spool(array $item)
        {
                // Now we store the data in the spool directory
                // We use "microtime" to keep the arrival order and "mt_rand" to avoid duplicates
                $file = 'item-' . round(microtime(true) * 10000) . '-' . mt_rand() . '.msg';
 
                $spoolpath = System::getSpoolPath();
-               if ($spoolpath != "") {
+               if ($spoolpath != '') {
                        $spool = $spoolpath . '/' . $file;
 
-                       file_put_contents($spool, json_encode($orig_item));
+                       file_put_contents($spool, json_encode($item));
                        Logger::warning("Item wasn't stored - Item was spooled into file", ['file' => $file]);
                }
        }
@@ -469,10 +483,10 @@ class Item
        /**
         * Check if the item array is a duplicate
         *
-        * @param array $item
+        * @param array $item Item record
         * @return boolean is it a duplicate?
         */
-       private static function isDuplicate(array $item)
+       private static function isDuplicate(array $item): bool
        {
                // Checking if there is already an item with the same guid
                $condition = ['guid' => $item['guid'], 'network' => $item['network'], 'uid' => $item['uid']];
@@ -521,10 +535,10 @@ class Item
        /**
         * Check if the item array is valid
         *
-        * @param array $item
+        * @param array $item Item record
         * @return boolean item is valid
         */
-       public static function isValid(array $item)
+       public static function isValid(array $item): bool
        {
                // When there is no content then we don't post it
                if (($item['body'] . $item['title'] == '') && (empty($item['uri-id']) || !Post\Media::existsByURIId($item['uri-id']))) {
@@ -591,10 +605,10 @@ class Item
        /**
         * Check if the item array is too old
         *
-        * @param array $item
+        * @param array $item Item record
         * @return boolean item is too old
         */
-       public static function isTooOld(array $item)
+       public static function isTooOld(array $item): bool
        {
                // check for create date and expire time
                $expire_interval = DI::config()->get('system', 'dbclean-expire-days', 0);
@@ -623,15 +637,20 @@ class Item
        /**
         * Return the id of the given item array if it has been stored before
         *
-        * @param array $item
-        * @return integer item id
+        * @param array $item Item record
+        * @return integer Item id or zero on error
         */
-       private static function getDuplicateID(array $item)
+       private static function getDuplicateID(array $item): int
        {
                if (empty($item['network']) || in_array($item['network'], Protocol::FEDERATED)) {
-                       $condition = ["`uri-id` = ? AND `uid` = ? AND `network` IN (?, ?, ?, ?)",
-                               $item['uri-id'], $item['uid'],
-                               Protocol::ACTIVITYPUB, Protocol::DIASPORA, Protocol::DFRN, Protocol::OSTATUS];
+                       $condition = ['`uri-id` = ? AND `uid` = ? AND `network` IN (?, ?, ?, ?)',
+                               $item['uri-id'],
+                               $item['uid'],
+                               Protocol::ACTIVITYPUB,
+                               Protocol::DIASPORA,
+                               Protocol::DFRN,
+                               Protocol::OSTATUS
+                       ];
                        $existing = Post::selectFirst(['id', 'network'], $condition);
                        if (DBA::isResult($existing)) {
                                // We only log the entries with a different user id than 0. Otherwise we would have too many false positives
@@ -640,12 +659,12 @@ class Item
                                                'uri-id' => $item['uri-id'],
                                                'uid' => $item['uid'],
                                                'network' => $item['network'],
-                                               'existing_id' => $existing["id"],
-                                               'existing_network' => $existing["network"]
+                                               'existing_id' => $existing['id'],
+                                               'existing_network' => $existing['network']
                                        ]);
                                }
 
-                               return $existing["id"];
+                               return $existing['id'];
                        }
                }
                return 0;
@@ -658,20 +677,25 @@ class Item
         * @return array item array with parent data
         * @throws \Exception
         */
-       private static function getTopLevelParent(array $item)
+       private static function getTopLevelParent(array $item): array
        {
                $fields = ['uid', 'uri', 'parent-uri', 'id', 'deleted',
                        'uri-id', 'parent-uri-id',
                        'allow_cid', 'allow_gid', 'deny_cid', 'deny_gid',
                        'wall', 'private', 'origin', 'author-id'];
-               $condition = ['uri-id' => $item['thr-parent-id'], 'uid' => $item['uid']];
+               $condition = ['uri-id' => [$item['thr-parent-id'], $item['parent-uri-id']], 'uid' => $item['uid']];
                $params = ['order' => ['id' => false]];
                $parent = Post::selectFirst($fields, $condition, $params);
 
-               if (!DBA::isResult($parent) && $item['origin']) {
+               if (!DBA::isResult($parent) && Post::exists(['uri-id' => [$item['thr-parent-id'], $item['parent-uri-id']], 'uid' => 0])) {
                        $stored = Item::storeForUserByUriId($item['thr-parent-id'], $item['uid']);
-                       Logger::info('Stored thread parent item for user', ['uri-id' => $item['thr-parent-id'], 'uid' => $item['uid'], 'stored' => $stored]);
-                       $parent = Post::selectFirst($fields, $condition, $params);
+                       if (!$stored && ($item['thr-parent-id'] != $item['parent-uri-id'])) {
+                               $stored = Item::storeForUserByUriId($item['parent-uri-id'], $item['uid']);
+                       }
+                       if ($stored) {
+                               Logger::info('Stored thread parent item for user', ['uri-id' => $item['thr-parent-id'], 'uid' => $item['uid'], 'stored' => $stored]);
+                               $parent = Post::selectFirst($fields, $condition, $params);
+                       }
                }
 
                if (!DBA::isResult($parent)) {
@@ -724,11 +748,20 @@ class Item
                } elseif ($activity->match($item['verb'], Activity::ANNOUNCE)) {
                        return GRAVITY_ACTIVITY;
                }
+
                Logger::info('Unknown gravity for verb', ['verb' => $item['verb']]);
                return GRAVITY_UNKNOWN;   // Should not happen
        }
 
-       public static function insert(array $item, int $notify = 0, bool $post_local = true)
+       /**
+        * Inserts item record
+        *
+        * @param array $item Item array to be inserted
+        * @param int   $notify Notification (type?)
+        * @param bool  $post_local (???)
+        * @return int Zero means error, otherwise primary key (id) is being returned
+        */
+       public static function insert(array $item, int $notify = 0, bool $post_local = true): int
        {
                $orig_item = $item;
 
@@ -752,17 +785,20 @@ class Item
                $uid = intval($item['uid']);
 
                $item['guid'] = self::guid($item, $notify);
-               $item['uri'] = substr(trim($item['uri'] ?? '') ?: self::newURI($item['uid'], $item['guid']), 0, 255);
+               $item['uri'] = substr(trim($item['uri'] ?? '') ?: self::newURI($item['guid']), 0, 255);
 
                // Store URI data
                $item['uri-id'] = ItemURI::insert(['uri' => $item['uri'], 'guid' => $item['guid']]);
 
                // Backward compatibility: parent-uri used to be the direct parent uri.
                // If it is provided without a thr-parent, it probably is the old behavior.
-               $item['thr-parent'] = trim($item['thr-parent'] ?? $item['parent-uri'] ?? $item['uri']);
-               $item['parent-uri'] = $item['thr-parent'];
+               if (empty($item['thr-parent']) || empty($item['parent-uri'])) {
+                       $item['thr-parent'] = trim($item['thr-parent'] ?? $item['parent-uri'] ?? $item['uri']);
+                       $item['parent-uri'] = $item['thr-parent'];
+               }
 
-               $item['thr-parent-id'] = $item['parent-uri-id'] = ItemURI::getIdByURI($item['thr-parent']);
+               $item['thr-parent-id'] = ItemURI::getIdByURI($item['thr-parent']);
+               $item['parent-uri-id'] = ItemURI::getIdByURI($item['parent-uri']);
 
                // Store conversation data
                $item = Conversation::insert($item);
@@ -869,10 +905,10 @@ class Item
                Contact::checkAvatarCache($item['owner-id']);
 
                // The contact-id should be set before "self::insert" was called - but there seems to be issues sometimes
-               $item["contact-id"] = self::contactId($item);
+               $item['contact-id'] = self::contactId($item);
 
                if (!empty($item['direction']) && in_array($item['direction'], [Conversation::PUSH, Conversation::RELAY]) &&
-                       empty($item['origin']) &&self::isTooOld($item)) {
+                       empty($item['origin']) && self::isTooOld($item)) {
                        Logger::info('Item is too old', ['item' => $item]);
                        return 0;
                }
@@ -938,14 +974,22 @@ class Item
                } else {
                        $parent_id = 0;
                        $parent_origin = $item['origin'];
+
+                       if ($item['wall'] && empty($item['conversation'])) {
+                               $item['conversation'] = $item['parent-uri'] . '#context';
+                       }
                }
 
                $item['parent-uri-id'] = ItemURI::getIdByURI($item['parent-uri']);
                $item['thr-parent-id'] = ItemURI::getIdByURI($item['thr-parent']);
 
+               if (!empty($item['conversation']) && empty($item['conversation-id'])) {
+                       $item['conversation-id'] = ItemURI::getIdByURI($item['conversation']);
+               }
+
                // Is this item available in the global items (with uid=0)?
-               if ($item["uid"] == 0) {
-                       $item["global"] = true;
+               if ($item['uid'] == 0) {
+                       $item['global'] = true;
 
                        // Set the global flag on all items if this was a global item entry
                        Post::update(['global' => true], ['uri-id' => $item['uri-id']]);
@@ -954,8 +998,8 @@ class Item
                }
 
                // ACL settings
-               if (!empty($item["allow_cid"] . $item["allow_gid"] . $item["deny_cid"] . $item["deny_gid"])) {
-                       $item["private"] = self::PRIVATE;
+               if (!empty($item['allow_cid'] . $item['allow_gid'] . $item['deny_cid'] . $item['deny_gid'])) {
+                       $item['private'] = self::PRIVATE;
                }
 
                if ($notify && $post_local) {
@@ -1802,38 +1846,37 @@ class Item
         * Posts that are created on this system are using System::createUUID.
         * Received ActivityPub posts are using Processor::getGUIDByURL.
         *
-        * @param string $uri uri of an item entry
-        * @param string $host hostname for the GUID prefix
-        * @return string unique guid
+        * @param string      $uri uri of an item entry
+        * @param string|null $host hostname for the GUID prefix
+        * @return string Unique guid
         */
-       public static function guidFromUri(string $uri, string $host): string
+       public static function guidFromUri(string $uri, string $host = null): string
        {
                // Our regular guid routine is using this kind of prefix as well
                // We have to avoid that different routines could accidentally create the same value
                $parsed = parse_url($uri);
 
                // Remove the scheme to make sure that "https" and "http" doesn't make a difference
-               unset($parsed["scheme"]);
+               unset($parsed['scheme']);
 
                // Glue it together to be able to make a hash from it
-               $host_id = implode("/", $parsed);
+               $host_id = implode('/', $parsed);
 
                // Use a mixture of several hashes to provide some GUID like experience
-               return hash("crc32", $host) . '-'. hash('joaat', $host_id) . '-'. hash('fnv164', $host_id);
+               return hash('crc32', $host) . '-'. hash('joaat', $host_id) . '-'. hash('fnv164', $host_id);
        }
 
        /**
         * generate an unique URI
         *
-        * @param integer $uid  User id
-        * @param string  $guid An existing GUID (Otherwise it will be generated)
+        * @param string $guid An existing GUID (Otherwise it will be generated)
         *
         * @return string
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function newURI($uid, $guid = "")
+       public static function newURI(string $guid = ''): string
        {
-               if ($guid == "") {
+               if ($guid == '') {
                        $guid = System::createUUID();
                }
 
@@ -2122,7 +2165,7 @@ class Item
                                $old_uri_id = $datarray["uri-id"] ?? 0;
                                $datarray["guid"] = System::createUUID();
                                unset($datarray["plink"]);
-                               $datarray["uri"] = self::newURI($contact['uid'], $datarray["guid"]);
+                               $datarray["uri"] = self::newURI($datarray["guid"]);
                                $datarray["uri-id"] = ItemURI::getIdByURI($datarray["uri"]);
                                $datarray["extid"] = Protocol::DFRN;
                                $urlpart = parse_url($datarray2['author-link']);
@@ -2563,7 +2606,7 @@ class Item
 
                $new_item = [
                        'guid'          => System::createUUID(),
-                       'uri'           => self::newURI($item['uid']),
+                       'uri'           => self::newURI(),
                        'uid'           => $item['uid'],
                        'contact-id'    => $owner['id'],
                        'wall'          => $item['wall'],
@@ -2803,7 +2846,8 @@ class Item
                        $shared_uri_id = 0;
                        $shared_links = [];
                }
-               $attachments = Post\Media::splitAttachments($item['uri-id'], $item['guid'] ?? '', $shared_links, $item['has-media']);
+
+               $attachments = Post\Media::splitAttachments($item['uri-id'], $item['guid'] ?? '', $shared_links, $item['has-media'] ?? false);
                $item['body'] = self::replaceVisualAttachments($attachments, $item['body'] ?? '');
 
                $item['body'] = preg_replace("/\s*\[attachment .*?\].*?\[\/attachment\]\s*/ism", "\n", $item['body']);
@@ -3382,7 +3426,9 @@ class Item
                        return is_numeric($hookData['item_id']) ? $hookData['item_id'] : 0;
                }
 
-               if ($fetched_uri = ActivityPub\Processor::fetchMissingActivity($uri)) {
+               $fetched_uri = ActivityPub\Processor::fetchMissingActivity($uri);
+
+               if ($fetched_uri) {
                        $item_id = self::searchByLink($fetched_uri, $uid);
                } else {
                        $item_id = Diaspora::fetchByURL($uri);
@@ -3409,18 +3455,7 @@ class Item
         */
        public static function getShareArray(array $item): array
        {
-               if (!preg_match("/(.*?)\[share(.*?)\]\s?(.*?)\s?\[\/share\]\s?/ism", $item['body'], $matches)) {
-                       return [];
-               }
-
-               $attribute_string = $matches[2];
-               $attributes = ['comment' => trim($matches[1]), 'shared' => trim($matches[3])];
-               foreach (['author', 'profile', 'avatar', 'guid', 'posted', 'link'] as $field) {
-                       if (preg_match("/$field=(['\"])(.+?)\\1/ism", $attribute_string, $matches)) {
-                               $attributes[$field] = trim(html_entity_decode($matches[2] ?? '', ENT_QUOTES, 'UTF-8'));
-                       }
-               }
-               return $attributes;
+               return BBCode::fetchShareAttributes($item['body']);
        }
 
        /**