From 75b3778dccccddb5cc90b2b4e0a3f958826ad8ba Mon Sep 17 00:00:00 2001
From: winter
Date: Wed, 15 Jan 2025 20:33:38 +0000
Subject: implement home timeline

---
 Digitigrade/Timeline/GlobalTimeline.php          |  2 -
 Digitigrade/Timeline/HomeTimeline.php            | 26 ++++++++++++
 Digitigrade/Timeline/HomeTimelineItem.php        | 52 ++++++++++++++++++++++++
 Digitigrade/Timeline/LocalTimeline.php           |  2 -
 Digitigrade/Timeline/ReasonReshared.php          | 24 +++++++++++
 Digitigrade/Timeline/Timeline.php                | 24 +++++++++++
 Digitigrade/Timeline/TimelineIncludeable.php     |  8 ++++
 Digitigrade/Timeline/TimelineInclusionReason.php |  8 ++++
 Digitigrade/Timeline/TimelineItem.php            | 20 +++++++++
 9 files changed, 162 insertions(+), 4 deletions(-)
 create mode 100644 Digitigrade/Timeline/HomeTimeline.php
 create mode 100644 Digitigrade/Timeline/HomeTimelineItem.php
 create mode 100644 Digitigrade/Timeline/ReasonReshared.php
 create mode 100644 Digitigrade/Timeline/Timeline.php
 create mode 100644 Digitigrade/Timeline/TimelineIncludeable.php
 create mode 100644 Digitigrade/Timeline/TimelineInclusionReason.php
 create mode 100644 Digitigrade/Timeline/TimelineItem.php

(limited to 'Digitigrade/Timeline')

diff --git a/Digitigrade/Timeline/GlobalTimeline.php b/Digitigrade/Timeline/GlobalTimeline.php
index 278b557..81eccfb 100644
--- a/Digitigrade/Timeline/GlobalTimeline.php
+++ b/Digitigrade/Timeline/GlobalTimeline.php
@@ -3,8 +3,6 @@ namespace Digitigrade\Timeline;
 
 use Digitigrade\Db;
 use Digitigrade\Model\Note;
-use Digitigrade\Timeline;
-use Digitigrade\TimelineItem;
 
 class GlobalTimeline extends Timeline {
     protected function getItems(int $limit, int $offset): array {
diff --git a/Digitigrade/Timeline/HomeTimeline.php b/Digitigrade/Timeline/HomeTimeline.php
new file mode 100644
index 0000000..c2baf3d
--- /dev/null
+++ b/Digitigrade/Timeline/HomeTimeline.php
@@ -0,0 +1,26 @@
+<?php
+namespace Digitigrade\Timeline;
+
+use Digitigrade\Model\UserAccount;
+
+class HomeTimeline extends Timeline {
+    private UserAccount $user;
+
+    public function __construct(UserAccount $user) {
+        $this->user = $user;
+    }
+
+    protected function getItems(int $limit, int $offset): array {
+        return array_map(
+            fn(HomeTimelineItem $hti) => $hti->toTimelineItem(),
+            HomeTimelineItem::findAllForUser($this->user, $limit, $offset)
+        );
+    }
+
+    public function getItemsSince(\DateTimeInterface $when, ?int $limit = null, int $offset = 0): array {
+        return array_map(
+            fn(HomeTimelineItem $hti) => $hti->toTimelineItem(),
+            HomeTimelineItem::findAllForUser($this->user, $limit, $offset, $when)
+        );
+    }
+}
\ No newline at end of file
diff --git a/Digitigrade/Timeline/HomeTimelineItem.php b/Digitigrade/Timeline/HomeTimelineItem.php
new file mode 100644
index 0000000..cb2b6e4
--- /dev/null
+++ b/Digitigrade/Timeline/HomeTimelineItem.php
@@ -0,0 +1,52 @@
+<?php
+namespace Digitigrade\Timeline;
+
+use Digitigrade\Model;
+use Digitigrade\Model\UserAccount;
+
+class HomeTimelineItem extends Model {
+    public ?int $id;
+    public UserAccount $userAccount;
+    public ?string $reasonKind;
+    public ?string $reasonData;
+    public string $itemKind;
+    public string $itemData;
+    public \DateTimeImmutable $modified;
+
+    /**
+     * Creates a new home timeline entry for a particular user, but does not save it.
+     */
+    public static function fromTimelineItem(TimelineItem $item, UserAccount $user): self {
+        $hti = new self();
+        $hti->userAccount = $user;
+        $reason = $item->getReason();
+        if ($reason != null) {
+            $hti->reasonKind = $reason::class;
+            $hti->reasonData = json_encode($reason->toJsonReference());
+        }
+        $object = $item->getObject();
+        $hti->itemKind = $object::class;
+        $hti->itemData = json_encode($object->toJsonReference());
+        $hti->modified = new \DateTimeImmutable();
+        return $hti;
+    }
+
+    public function toTimelineItem(): TimelineItem {
+        $reason = null;
+        if (isset($this->reasonKind)) {
+            $reason = $this->reasonKind::fromJsonReference(json_decode($this->reasonData));
+        }
+        $object = $this->itemKind::fromJsonReference(json_decode($this->itemData));
+        return new TimelineItem($object, $reason);
+    }
+
+    public static function findAllForUser(UserAccount $user, ?int $limit = null, int $offset = 0, ?\DateTimeInterface $since = null) {
+        $where = 'user_account = ?';
+        $params = [$user->id];
+        if (isset($since)) {
+            $where .= ' AND modified > ?';
+            $params[] = $since->format('c');
+        }
+        return self::findAllWhere($where, $params, $limit, $offset, 'id DESC');
+    }
+}
\ No newline at end of file
diff --git a/Digitigrade/Timeline/LocalTimeline.php b/Digitigrade/Timeline/LocalTimeline.php
index c20ada6..6129576 100644
--- a/Digitigrade/Timeline/LocalTimeline.php
+++ b/Digitigrade/Timeline/LocalTimeline.php
@@ -3,8 +3,6 @@ namespace Digitigrade\Timeline;
 
 use Digitigrade\Db;
 use Digitigrade\Model\Note;
-use Digitigrade\Timeline;
-use Digitigrade\TimelineItem;
 
 class LocalTimeline extends Timeline {
     protected function getItems(int $limit, int $offset): array {
diff --git a/Digitigrade/Timeline/ReasonReshared.php b/Digitigrade/Timeline/ReasonReshared.php
new file mode 100644
index 0000000..2ffe1b2
--- /dev/null
+++ b/Digitigrade/Timeline/ReasonReshared.php
@@ -0,0 +1,24 @@
+<?php
+namespace Digitigrade\Timeline;
+
+use Digitigrade\Model\Actor;
+
+class ReasonReshared extends TimelineInclusionReason {
+    private Actor $resharer;
+
+    public function __construct(Actor $resharer) {
+        $this->resharer = $resharer;
+    }
+
+    public function renderAsHtml() {
+        render_template('reason_reshared', ['actor' => $this->resharer]);
+    }
+
+    public function toJsonReference(): mixed {
+        return $this->resharer->id;
+    }
+
+    public static function fromJsonReference(mixed $reference): self {
+        return new self(Actor::find($reference));
+    }
+}
\ No newline at end of file
diff --git a/Digitigrade/Timeline/Timeline.php b/Digitigrade/Timeline/Timeline.php
new file mode 100644
index 0000000..b3def28
--- /dev/null
+++ b/Digitigrade/Timeline/Timeline.php
@@ -0,0 +1,24 @@
+<?php
+namespace Digitigrade\Timeline;
+
+abstract class Timeline {
+    // TODO: currently making this number up. probably should be modifiable somewhere
+    private const RESULTS_PER_PAGE = 50;
+
+    /**
+     * Gets a pageful of items to be included in the timeline
+     * @param int $page page number to return (0-indexed)
+     * @return TimelineItem[]
+     */
+    public function getPage(int $page = 0): array {
+        return $this->getItems(self::RESULTS_PER_PAGE, self::RESULTS_PER_PAGE * $page);
+    }
+
+    /**
+     * Gets a selection of items to be included in the timeline
+     * @param int $limit max number of items to return
+     * @param int $offset number of items to skip at first
+     * @return TimelineItem[]
+     */
+    abstract protected function getItems(int $limit, int $offset): array;
+}
\ No newline at end of file
diff --git a/Digitigrade/Timeline/TimelineIncludeable.php b/Digitigrade/Timeline/TimelineIncludeable.php
new file mode 100644
index 0000000..5406543
--- /dev/null
+++ b/Digitigrade/Timeline/TimelineIncludeable.php
@@ -0,0 +1,8 @@
+<?php
+namespace Digitigrade\Timeline;
+
+interface TimelineIncludeable {
+    public function renderAsHtml();
+    public function toJsonReference(): mixed;
+    public static function fromJsonReference(mixed $reference): self;
+}
\ No newline at end of file
diff --git a/Digitigrade/Timeline/TimelineInclusionReason.php b/Digitigrade/Timeline/TimelineInclusionReason.php
new file mode 100644
index 0000000..6ffe76d
--- /dev/null
+++ b/Digitigrade/Timeline/TimelineInclusionReason.php
@@ -0,0 +1,8 @@
+<?php
+namespace Digitigrade\Timeline;
+
+abstract class TimelineInclusionReason {
+    abstract public function renderAsHtml();
+    abstract public function toJsonReference(): mixed;
+    abstract public static function fromJsonReference(mixed $reference): self;
+}
\ No newline at end of file
diff --git a/Digitigrade/Timeline/TimelineItem.php b/Digitigrade/Timeline/TimelineItem.php
new file mode 100644
index 0000000..d6ba563
--- /dev/null
+++ b/Digitigrade/Timeline/TimelineItem.php
@@ -0,0 +1,20 @@
+<?php
+namespace Digitigrade\Timeline;
+
+class TimelineItem {
+    private ?TimelineInclusionReason $reason;
+    private TimelineIncludeable $object;
+
+    public function __construct(TimelineIncludeable $object, ?TimelineInclusionReason $reason = null) {
+        $this->reason = $reason;
+        $this->object = $object;
+    }
+
+    public function getReason(): ?TimelineInclusionReason {
+        return $this->reason;
+    }
+
+    public function getObject(): TimelineIncludeable {
+        return $this->object;
+    }
+}
\ No newline at end of file
-- 
cgit v1.3