[CARDS][Note] AppendCardNote event overhaul

[PLUGINS][Favourite] Added complementary information on user action [COMPONENTS][Conversation] Fixed AppendCardNote issue where cached query would only act on Notes with depth > 1
2021-12-29 17:54:02 +00:00
parent 0caec6ab9e
commit 836560f55f
7 changed files with 83 additions and 80 deletions
--- a/plugins/Favourite/Entity/NoteFavourite.php
+++ b/plugins/Favourite/Entity/NoteFavourite.php
@@ -0,0 +1,135 @@
+<?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 Plugin\Favourite\Entity;
+
+use App\Core\DB\DB;
+use App\Core\Entity;
+use App\Entity\Note;
+use DateTimeInterface;
+
+class NoteFavourite extends Entity
+{
+    // {{{ Autocode
+    // @codeCoverageIgnoreStart
+    private int $note_id;
+    private int $actor_id;
+    private DateTimeInterface $created;
+    private DateTimeInterface $modified;
+
+    public function setNoteId(int $note_id): self
+    {
+        $this->note_id = $note_id;
+        return $this;
+    }
+
+    public function getNoteId(): int
+    {
+        return $this->note_id;
+    }
+
+    public function setActorId(int $actor_id): self
+    {
+        $this->actor_id = $actor_id;
+        return $this;
+    }
+
+    public function getActorId(): int
+    {
+        return $this->actor_id;
+    }
+
+    public function setCreated(DateTimeInterface $created): self
+    {
+        $this->created = $created;
+        return $this;
+    }
+
+    public function getCreated(): DateTimeInterface
+    {
+        return $this->created;
+    }
+
+    public function setModified(DateTimeInterface $modified): self
+    {
+        $this->modified = $modified;
+        return $this;
+    }
+
+    public function getModified(): DateTimeInterface
+    {
+        return $this->modified;
+    }
+
+    // @codeCoverageIgnoreEnd
+    // }}} Autocode
+
+    public static function getNoteFavouriteActors(Note $note): array
+    {
+        return DB::dql(
+            <<<'EOF'
+                select a from actor as a
+                inner join note_favourite as nf
+                with nf.note_id = :note_id 
+                where a.id = nf.actor_id
+                order by nf.created DESC
+                EOF,
+            ['note_id' => $note->getId()],
+        );
+    }
+
+    public function getNotificationTargetIds(array $ids_already_known = [], ?int $sender_id = null, bool $include_additional = true): array
+    {
+        if (!\array_key_exists('object', $ids_already_known)) {
+            $target_ids = Note::getById($this->getNoteId())->getNotificationTargetIds();
+        } else {
+            $target_ids = $ids_already_known['object'];
+        }
+
+        // Additional actors that should know about this
+        if ($include_additional && \array_key_exists('additional', $ids_already_known)) {
+            array_push($target_ids, ...$ids_already_known['additional']);
+        } else {
+            return $target_ids;
+        }
+
+        return array_unique($target_ids);
+    }
+
+    public static function schemaDef()
+    {
+        return [
+            'name'   => 'note_favourite',
+            'fields' => [
+                'note_id'  => ['type' => 'int', 'foreign key' => true, 'target' => 'App\Entity\Note.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'note that is the favorite of'],
+                'actor_id' => ['type' => 'int', 'foreign key' => true, 'target' => 'App\Entity\Actor.id', 'multiplicity' => 'one to one', 'not null' => true, 'description' => 'actor who favourited this note'],  // note: formerly referenced notice.id, but we can now record remote users' favorites
+                'created'  => ['type' => 'datetime', 'not null' => true, 'description' => 'date this record was created'],
+                'modified' => ['type' => 'timestamp', 'not null' => true, 'description' => 'date this record was modified'],
+            ],
+            'primary key' => ['note_id', 'actor_id'],
+            'indexes'     => [
+                'fave_note_id_idx'  => ['note_id'],
+                'fave_actor_id_idx' => ['actor_id', 'modified'],
+                'fave_modified_idx' => ['modified'],
+            ],
+        ];
+    }
+}