Add a type filter to the modlogs (#1714)

Author: BentiGorlich

assets/styles/app.scss

@@ -51,6 +51,7 @@
 @use 'pages/post_single';
 @use 'pages/post_front';
 @use 'pages/page_bookmarks';
+@use 'pages/page_modlog';
 @use 'themes/kbin';
 @use 'themes/default';
 @use 'themes/solarized';

assets/styles/layout/_layout.scss

@@ -370,6 +370,10 @@ figure {
   gap: .25rem;
 }
 
+.flex-item {
+  flex-grow: 1;
+}
+
 @include b.media-breakpoint-down(lg) {
   .flex.mobile {
     display: block;

assets/styles/pages/page_modlog.scss

@@ -0,0 +1,9 @@
+.page-modlog {
+  .ts-wrapper .ts-control input {
+    min-width: unset;
+  }
+
+  .ts-wrapper {
+    margin-bottom: 0;
+  }
+}

config/mbin_routes/magazine.yaml

@@ -40,7 +40,7 @@ magazine_moderators:
     methods: [GET]
 
 magazine_modlog:
-    controller: App\Controller\Magazine\MagazineLogController
+    controller: App\Controller\ModlogController::magazine
     path: /m/{name}/modlog
     methods: [GET]
 

config/mbin_routes/modlog.yaml

@@ -1,4 +1,4 @@
 modlog:
-  controller: App\Controller\ModlogController
+  controller: App\Controller\ModlogController::instance
   path: /modlog
   methods: [ GET ]

src/Controller/Api/Instance/InstanceModLogApi.php

@@ -5,11 +5,13 @@
 namespace App\Controller\Api\Instance;
 
 use App\DTO\MagazineLogResponseDto;
+use App\Entity\MagazineLog;
 use App\Repository\MagazineLogRepository;
 use App\Schema\PaginationSchema;
 use Nelmio\ApiDocBundle\Attribute\Model;
 use OpenApi\Attributes as OA;
 use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
 use Symfony\Component\RateLimiter\RateLimiterFactory;
 
 class InstanceModLogApi extends InstanceBaseApi
@@ -64,6 +66,12 @@ class InstanceModLogApi extends InstanceBaseApi
         in: 'query',
         schema: new OA\Schema(type: 'integer', default: MagazineLogRepository::PER_PAGE, minimum: self::MIN_PER_PAGE, maximum: self::MAX_PER_PAGE)
     )]
+    #[OA\Parameter(
+        name: 'types[]',
+        description: 'The types of magazine logs to retrieve',
+        in: 'query',
+        schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string', enum: MagazineLog::CHOICES))
+    )]
     #[OA\Tag('instance')]
     /**
      * Retrieve information about moderation actions taken across the instance.
@@ -72,18 +80,20 @@ public function collection(
         MagazineLogRepository $repository,
         RateLimiterFactory $apiReadLimiter,
         RateLimiterFactory $anonymousApiReadLimiter,
+        #[MapQueryParameter] ?array $types = null,
     ): JsonResponse {
         $headers = $this->rateLimit($apiReadLimiter, $anonymousApiReadLimiter);
 
         $request = $this->request->getCurrentRequest();
-        $logs = $repository->listAll(
+        $logs = $repository->findByCustom(
             $this->getPageNb($request),
-            self::constrainPerPage($request->get('perPage', MagazineLogRepository::PER_PAGE))
+            self::constrainPerPage($request->get('perPage', MagazineLogRepository::PER_PAGE)),
+            types: $types,
         );
 
         $dtos = [];
         foreach ($logs->getCurrentPageResults() as $value) {
-            array_push($dtos, $this->serializeLogItem($value));
+            $dtos[] = $this->serializeLogItem($value);
         }
 
         return new JsonResponse(

src/Controller/Api/Magazine/MagazineModLogApi.php

@@ -6,13 +6,14 @@
 
 use App\DTO\MagazineLogResponseDto;
 use App\Entity\Magazine;
+use App\Entity\MagazineLog;
 use App\Repository\MagazineLogRepository;
-use App\Repository\MagazineRepository;
 use App\Schema\PaginationSchema;
 use Nelmio\ApiDocBundle\Attribute\Model;
 use OpenApi\Attributes as OA;
 use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\HttpKernel\Attribute\MapQueryParameter;
 use Symfony\Component\RateLimiter\RateLimiterFactory;
 
 class MagazineModLogApi extends MagazineBaseApi
@@ -78,29 +79,37 @@ class MagazineModLogApi extends MagazineBaseApi
         in: 'query',
         schema: new OA\Schema(type: 'integer', default: MagazineLogRepository::PER_PAGE, minimum: self::MIN_PER_PAGE, maximum: self::MAX_PER_PAGE)
     )]
+    #[OA\Parameter(
+        name: 'types[]',
+        description: 'The types of magazine logs to retrieve',
+        in: 'query',
+        schema: new OA\Schema(type: 'array', items: new OA\Items(type: 'string', enum: MagazineLog::CHOICES))
+    )]
     #[OA\Tag('magazine')]
     /**
      * Retrieve information about moderation actions taken in the magazine.
      */
     public function collection(
         #[MapEntity(id: 'magazine_id')]
         Magazine $magazine,
-        MagazineRepository $repository,
+        MagazineLogRepository $repository,
         RateLimiterFactory $apiReadLimiter,
         RateLimiterFactory $anonymousApiReadLimiter,
+        #[MapQueryParameter] ?array $types = null,
     ): JsonResponse {
         $headers = $this->rateLimit($apiReadLimiter, $anonymousApiReadLimiter);
 
         $request = $this->request->getCurrentRequest();
-        $logs = $repository->findModlog(
-            $magazine,
+        $logs = $repository->findByCustom(
             $this->getPageNb($request),
-            self::constrainPerPage($request->get('perPage', MagazineLogRepository::PER_PAGE))
+            self::constrainPerPage($request->get('perPage', MagazineLogRepository::PER_PAGE)),
+            types: $types,
+            magazine: $magazine,
         );
 
         $dtos = [];
         foreach ($logs->getCurrentPageResults() as $value) {
-            array_push($dtos, $this->serializeLogItem($value));
+            $dtos[] = $this->serializeLogItem($value);
         }
 
         return new JsonResponse(

src/Controller/Magazine/MagazineLogController.php

@@ -4,18 +4,73 @@
 
 namespace App\Controller;
 
+use App\DTO\ModlogFilterDto;
+use App\Entity\Magazine;
+use App\Form\ModlogFilterType;
 use App\Repository\MagazineLogRepository;
+use Symfony\Bridge\Doctrine\Attribute\MapEntity;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
 class ModlogController extends AbstractController
 {
-    public function __invoke(MagazineLogRepository $repository, Request $request): Response
+    public function __construct(
+        private readonly MagazineLogRepository $magazineLogRepository,
+    ) {
+    }
+
+    public function instance(Request $request): Response
     {
+        $dto = new ModlogFilterDto();
+        $dto->magazine = null;
+        $form = $this->createForm(ModlogFilterType::class, $dto, ['method' => 'GET']);
+        $form->handleRequest($request);
+        if ($form->isSubmitted() && $form->isValid()) {
+            /** @var ModlogFilterDto $dto */
+            $dto = $form->getData();
+
+            if (null !== $dto->magazine) {
+                return $this->redirectToRoute('magazine_modlog', ['name' => $dto->magazine->name]);
+            }
+            $logs = $this->magazineLogRepository->findByCustom($this->getPageNb($request), types: $dto->types);
+        } else {
+            $logs = $this->magazineLogRepository->findByCustom($this->getPageNb($request));
+        }
+
+        return $this->render(
+            'modlog/front.html.twig',
+            [
+                'logs' => $logs,
+                'form' => $form,
+            ]
+        );
+    }
+
+    public function magazine(#[MapEntity] ?Magazine $magazine, Request $request): Response
+    {
+        $dto = new ModlogFilterDto();
+        $dto->magazine = $magazine;
+        $form = $this->createForm(ModlogFilterType::class, $dto, ['method' => 'GET']);
+        $form->handleRequest($request);
+        if ($form->isSubmitted() && $form->isValid()) {
+            /** @var ModlogFilterDto $dto */
+            $dto = $form->getData();
+            if (null === $dto->magazine) {
+                return $this->redirectToRoute('modlog');
+            } elseif ($dto->magazine?->name !== $magazine->name) {
+                return $this->redirectToRoute('magazine_modlog', ['name' => $dto->magazine->name]);
+            }
+            $logs = $this->magazineLogRepository->findByCustom($this->getPageNb($request), types: $dto->types, magazine: $magazine);
+        } else {
+            $logs = $this->magazineLogRepository->findByCustom($this->getPageNb($request), magazine: $magazine);
+        }
+
         return $this->render(
             'modlog/front.html.twig',
             [
-                'logs' => $repository->listAll($this->getPageNb($request)),
+                'magazine' => $magazine,
+                'logs' => $logs,
+                'form' => $form,
             ]
         );
     }

src/Controller/ModlogController.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\DTO;
+
+use App\Entity\Magazine;
+
+class ModlogFilterDto
+{
+    /**
+     * @var string[]
+     */
+    public array $types;
+
+    public ?Magazine $magazine;
+}