feat(comments): add like / undo like to comment + add comment page

app/Controllers/EpisodeCommentController.php

@@ -0,0 +1,173 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright  2020 Podlibre
+ * @license    https://www.gnu.org/licenses/agpl-3.0.en.html AGPL3
+ * @link       https://castopod.org/
+ */
+
+namespace App\Controllers;
+
+use ActivityPub\Entities\Actor;
+use ActivityPub\Objects\OrderedCollectionObject;
+use ActivityPub\Objects\OrderedCollectionPage;
+use Analytics\AnalyticsTrait;
+use App\Controllers\Admin\BaseController;
+use App\Entities\Episode;
+use App\Entities\EpisodeComment;
+use App\Entities\Podcast;
+use App\Libraries\CommentObject;
+use App\Models\EpisodeCommentModel;
+use App\Models\EpisodeModel;
+use App\Models\PodcastModel;
+use CodeIgniter\Exceptions\PageNotFoundException;
+use CodeIgniter\HTTP\RedirectResponse;
+use CodeIgniter\HTTP\Response;
+
+class EpisodeCommentController extends BaseController
+{
+    use AnalyticsTrait;
+
+    protected Podcast $podcast;
+
+    protected Actor $actor;
+
+    protected Episode $episode;
+
+    protected EpisodeComment $comment;
+
+    public function _remap(string $method, string ...$params): mixed
+    {
+        if (count($params) < 3) {
+            throw PageNotFoundException::forPageNotFound();
+        }
+
+        if (
+            ($podcast = (new PodcastModel())->getPodcastByHandle($params[0])) === null
+        ) {
+            throw PageNotFoundException::forPageNotFound();
+        }
+
+        $this->podcast = $podcast;
+        $this->actor = $podcast->actor;
+
+        if (
+            ($episode = (new EpisodeModel())->getEpisodeBySlug($params[0], $params[1])) === null
+            ) {
+            throw PageNotFoundException::forPageNotFound();
+        }
+
+        $this->episode = $episode;
+
+        if (
+            ($comment = (new EpisodeCommentModel())->getCommentById($params[2])) === null
+        ) {
+            throw PageNotFoundException::forPageNotFound();
+        }
+
+        $this->comment = $comment;
+
+        unset($params[2]);
+        unset($params[1]);
+        unset($params[0]);
+
+        return $this->{$method}(...$params);
+    }
+
+    public function view(): string
+    {
+        // Prevent analytics hit when authenticated
+        if (! can_user_interact()) {
+            $this->registerPodcastWebpageHit($this->podcast->id);
+        }
+
+        $cacheName = implode(
+            '_',
+            array_filter([
+                'page',
+                "comment#{$this->comment->id}",
+                service('request')
+                    ->getLocale(),
+                can_user_interact() ? '_authenticated' : null,
+            ]),
+        );
+
+        if (! ($cachedView = cache($cacheName))) {
+            $data = [
+                'podcast' => $this->podcast,
+                'actor' => $this->actor,
+                'episode' => $this->episode,
+                'comment' => $this->comment,
+            ];
+
+            // if user is logged in then send to the authenticated activity view
+            if (can_user_interact()) {
+                helper('form');
+                return view('podcast/comment_authenticated', $data);
+            }
+            return view('podcast/comment', $data, [
+                'cache' => DECADE,
+                'cache_name' => $cacheName,
+            ]);
+        }
+
+        return $cachedView;
+    }
+
+    /**
+     * @noRector ReturnTypeDeclarationRector
+     */
+    public function commentObject(): Response
+    {
+        $commentObject = new CommentObject($this->comment);
+
+        return $this->response
+            ->setContentType('application/json')
+            ->setBody($commentObject->toJSON());
+    }
+
+    public function replies(): Response
+    {
+        /**
+         * get comment replies
+         */
+        $commentReplies = model('CommentModel', false)
+            ->where('in_reply_to_id', service('uuid')->fromString($this->comment->id)->getBytes())
+            ->orderBy('created_at', 'ASC');
+
+        $pageNumber = (int) $this->request->getGet('page');
+
+        if ($pageNumber < 1) {
+            $commentReplies->paginate(12);
+            $pager = $commentReplies->pager;
+            $collection = new OrderedCollectionObject(null, $pager);
+        } else {
+            $paginatedReplies = $commentReplies->paginate(12, 'default', $pageNumber);
+            $pager = $commentReplies->pager;
+
+            $orderedItems = [];
+            if ($paginatedReplies !== null) {
+                foreach ($paginatedReplies as $reply) {
+                    $replyObject = new CommentObject($reply);
+                    $orderedItems[] = $replyObject;
+                }
+            }
+
+            $collection = new OrderedCollectionPage($pager, $orderedItems);
+        }
+
+        return $this->response
+            ->setContentType('application/activity+json')
+            ->setBody($collection->toJSON());
+    }
+
+    public function attemptLike(): RedirectResponse
+    {
+        model('LikeModel')
+            ->toggleLike(interact_as_actor(), $this->comment);
+
+        return redirect()->back();
+    }
+}