[COMPONENT][Notification] Re-introduce the concept of note attention

Minor refactoring and bug fixing

components/Blog/Controller/Post.php

@@ -72,6 +72,9 @@ class Post extends Controller
         ];
         Event::handle('PostingAvailableContentTypes', [&$available_content_types]);
 
+        if (!is_int($this->int('in'))) {
+            throw new \InvalidArgumentException('You must specify an In group/org.');
+        }
         $context_actor = Actor::getById($this->int('in'));
         if (!$context_actor->isGroup()) {
             throw new \InvalidArgumentException('Only group blog posts are supported for now.');
@@ -135,18 +138,14 @@ class Post extends Controller
                     $extra_args   = [];
                     Event::handle('AddExtraArgsToNoteContent', [$request, $actor, $data, &$extra_args, $form_params, $form]);
 
-                    if (\array_key_exists('in', $data) && $data['in'] !== 'public') {
-                        $target = $data['in'];
-                    }
-
                     Posting::storeLocalNote(
                         actor: $actor,
                         content: $data['content'],
                         content_type: $content_type,
                         locale: $data['language'],
                         scope: VisibilityScope::from($data['visibility']),
-                        target: $target ?? null,
+                        targets: [(int)$data['in']],
-                        reply_to_id: $data['reply_to_id'],
+                        reply_to: $data['reply_to_id'],
                         attachments: $data['attachments'],
                         process_note_content_extra_args: $extra_args,
                     );

components/Notification/Entity/Attention.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types = 1);
+
+// {{{ License
+// This file is part of GNU social - https://www.gnu.org/software/social
+//
+// GNU social is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// GNU social is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public License
+// along with GNU social.  If not, see <http://www.gnu.org/licenses/>.
+// }}}
+
+namespace Component\Notification\Entity;
+
+use App\Core\Entity;
+
+/**
+ * Entity for note attentions
+ *
+ * @category  DB
+ * @package   GNUsocial
+ *
+ * @author    Diogo Peralta Cordeiro <@diogo.site>
+ * @copyright 2022 Free Software Foundation, Inc http://www.fsf.org
+ * @license   https://www.gnu.org/licenses/agpl.html GNU AGPL v3 or later
+ */
+class Attention extends Entity
+{
+    // {{{ Autocode
+    // @codeCoverageIgnoreStart
+    private int $note_id;
+    private int $target_id;
+
+    public function setNoteId(int $note_id): self
+    {
+        $this->note_id = $note_id;
+        return $this;
+    }
+
+    public function getNoteId(): int
+    {
+        return $this->note_id;
+    }
+
+    public function setTargetId(int $target_id): self
+    {
+        $this->target_id = $target_id;
+        return $this;
+    }
+
+    public function getTargetId(): int
+    {
+        return $this->target_id;
+    }
+
+    // @codeCoverageIgnoreEnd
+    // }}} Autocode
+
+    public static function schemaDef(): array
+    {
+        return [
+            'name'        => 'note_attention',
+            'description' => 'Note attentions to actors (that are not a mention)',
+            'fields'      => [
+                'note_id'   => ['type' => 'int', 'foreign key' => true, 'target' => 'Note.id',  'multiplicity' => 'one to one', 'not null' => true, 'description' => 'note_id to give attention'],
+                'target_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'Actor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'actor_id for feed receiver'],
+            ],
+            'primary key' => ['note_id', 'target_id'],
+            'indexes'     => [
+                'attention_note_id_idx'   => ['note_id'],
+                'attention_target_id_idx' => ['target_id'],
+            ],
+        ];
+    }
+}

components/Posting/Posting.php

@@ -28,6 +28,8 @@ use App\Core\DB\DB;
 use App\Core\Event;
 use App\Core\Form;
 use App\Core\GSFile;
+use App\Entity\NoteType;
+use Component\Notification\Entity\Attention;
 use function App\Core\I18n\_m;
 use App\Core\Modules\Component;
 use App\Core\Router\Router;
@@ -179,8 +181,8 @@ class Posting extends Component
                         content_type: $content_type,
                         locale: $data['language'],
                         scope: VisibilityScope::from($data['visibility']),
-                        target: $target ?? null,
+                        targets: isset($target) ? [$target] : [],
-                        reply_to_id: $data['reply_to_id'],
+                        reply_to: $data['reply_to_id'],
                         attachments: $data['attachments'],
                         process_note_content_extra_args: $extra_args,
                     );
@@ -213,39 +215,41 @@ class Posting extends Component
      * $actor_id, possibly as a reply to note $reply_to and with flag
      * $is_local. Sanitizes $content and $attachments
      *
-     * @param Actor                $actor                           The Actor responsible for the creation of this Note
+     * @param Actor $actor The Actor responsible for the creation of this Note
-     * @param null|string          $content                         The raw text content sent via Posting form
+     * @param null|string $content The raw text content
-     * @param string               $content_type                    Indicating one of the various supported text format (Plain Text, Markdown, LaTeX...)
+     * @param string $content_type Indicating one of the various supported content format (Plain Text, Markdown, LaTeX...)
-     * @param null|string          $locale                          Note's written text language, set by the default Actor language or upon filling Posting's form
+     * @param null|string $locale Note's written text language, set by the default Actor language or upon filling
-     * @param null|VisibilityScope $scope                           The scope of this Note
+     * @param null|VisibilityScope $scope The visibility of this Note
-     * @param null|Actor|int       $target                          Filled by PostingFillTargetChoices, representing an Actor in its many forms to be targeted by this Note
+     * @param array $targets Actor|int[]: In Group/To Person or Bot, registers an attention between note and target
-     * @param null|int             $reply_to_id                     The soon-to-be Note parent's id, if it's a Reply itself
+     * @param null|int|Note $reply_to The soon-to-be Note parent's id, if it's a Reply itself
-     * @param array                $attachments                     Array of UploadedFile to be stored as GSFiles associated to this note
+     * @param array $attachments UploadedFile[] to be stored as GSFiles associated to this note
-     * @param array                $processed_attachments           Array of [Attachment, Attachment's name] to be associated to this $actor and Note
+     * @param array $processed_attachments Array of [Attachment, Attachment's name][] to be associated to this $actor and Note
-     * @param array                $process_note_content_extra_args Extra arguments for the event ProcessNoteContent
+     * @param array $process_note_content_extra_args Extra arguments for the event ProcessNoteContent
-     * @param bool                 $notify                          True if the newly created Note activity should be passed on as a Notification
+     * @param bool $notify True if the newly created Note activity should be passed on as a Notification
-     * @param null|string          $rendered                        The Note's content post RenderNoteContent event, which sanitizes and processes the raw content sent
+     * @param null|string $rendered The Note's content post RenderNoteContent event, which sanitizes and processes the raw content sent
-     *
+     * @param string $source The source of this Note
+     * @return Note
      * @throws ClientException
      * @throws DuplicateFoundException
      * @throws ServerException
      */
     public static function storeLocalNote(
-        Actor $actor,
+        Actor            $actor,
-        ?string $content,
+        ?string          $content,
-        string $content_type,
+        string           $content_type,
-        ?string $locale = null,
+        ?string          $locale = null,
         ?VisibilityScope $scope = null,
-        null|Actor|int $target = null,
+        array            $targets = [],
-        ?int $reply_to_id = null,
+        null|int|Note    $reply_to = null,
-        array $attachments = [],
+        array            $attachments = [],
-        array $processed_attachments = [],
+        array            $processed_attachments = [],
-        array $process_note_content_extra_args = [],
+        array            $process_note_content_extra_args = [],
-        bool $notify = true,
+        bool             $notify = true,
-        ?string $rendered = null,
+        ?string          $rendered = null,
-        string $source = 'web',
+        string           $source = 'web',
     ): Note {
         $scope ??= VisibilityScope::EVERYWHERE; // TODO: If site is private, default to LOCAL
+        $reply_to_id = is_null($reply_to) ? null : (is_int($reply_to) ? $reply_to : $reply_to->getId());
         $mentions = [];
         if (\is_null($rendered) && !empty($content)) {
             Event::handle('RenderNoteContent', [$content, $content_type, &$rendered, $actor, $locale, &$mentions]);
@@ -304,8 +308,9 @@ class Posting extends Component
         ]);
         DB::persist($activity);
 
-        if (!\is_null($target)) {
+        foreach ($targets as $target) {
             $target     = \is_int($target) ? Actor::getById($target) : $target;
+            DB::persist(Attention::create(['note_id' => $note->getId(), 'target_id' => $target->getId()]));
             $mentions[] = [
                 'mentioned'       => [$target],
                 'type'            => match ($target->getType()) {

plugins/RepeatNote/RepeatNote.php

@@ -86,7 +86,7 @@ class RepeatNote extends NoteHandlerPlugin
             content_type: $note->getContentType(),
             locale: \is_null($lang_id = $note->getLanguageId()) ? null : Language::getById($lang_id)->getLocale(),
             // If it's a repeat, the reply_to should be to the original, conversation ought to be the same
-            reply_to_id: $note->getReplyTo(),
+            reply_to: $note->getReplyTo(),
             processed_attachments: $note->getAttachmentsWithTitle(),
             notify: false,
             rendered: $note->getRendered(),

src/Entity/Note.php

@@ -210,7 +210,7 @@ class Note extends Entity
         return $this->language_id;
     }
 
-    public function setType(VisibilityScope|int $type): self
+    public function setType(NoteType|int $type): self
     {
         $this->type = is_int($type) ? $type : $type->value;
         return $this;