jikan-me · irfan-dahir · Nov 28, 2022 · Nov 28, 2022 · Nov 28, 2022 · Nov 28, 2022
@@ -2,26 +2,16 @@
 
 namespace App\Http\Controllers\V4DB;
 
-use App\Anime;
-use App\Character;
-use App\Http\HttpHelper;
-use App\Http\HttpResponse;
-use App\Http\QueryBuilder\SearchQueryBuilderUsers;
-use App\Http\QueryBuilder\TopQueryBuilderAnime;
-use App\Http\QueryBuilder\TopQueryBuilderManga;
 use App\Http\Resources\V4\AnimeCollection;
 use App\Http\Resources\V4\CharacterCollection;
 use App\Http\Resources\V4\MangaCollection;
 use App\Http\Resources\V4\PersonCollection;
 use App\Http\Resources\V4\ResultsResource;
-use App\Manga;
-use App\Person;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\DB;
 use Jikan\Helper\Constants;
 use Jikan\Request\Reviews\RecentReviewsRequest;
-use Jikan\Request\Top\TopPeopleRequest;
-use MongoDB\BSON\UTCDateTime;
+
 
 class TopController extends ControllerWithQueryBuilderProvider
 {
@@ -46,6 +36,19 @@ class TopController extends ControllerWithQueryBuilderProvider
      *          @OA\Schema(type="string",enum={"airing", "upcoming", "bypopularity", "favorite"})
      *      ),
      *
+     *     @OA\Parameter(
+     *       name="rating",
+     *       in="query",
+     *       @OA\Schema(ref="#/components/schemas/anime_search_query_rating")
+     *     ),
+     *
+     *     @OA\Parameter(
+     *       name="sfw",
+     *       in="query",
+     *       description="Filter out Adult entries",
+     *       @OA\Schema(type="boolean")
+     *     ),
+     *
      *     @OA\Parameter(ref="#/components/parameters/page"),
      *     @OA\Parameter(ref="#/components/parameters/limit"),
      *

@@ -2,55 +2,31 @@
 
 namespace App\Http\QueryBuilder;
 
+use App\Http\QueryBuilder\Traits\TopMediaQueryParameterSanitizer;
 use App\Http\QueryBuilder\Traits\TopQueryFilterResolver;
 use App\Services\ScoutSearchService;
 use Illuminate\Support\Collection;
 
 class TopAnimeQueryBuilder extends AnimeSearchQueryBuilder
 {
-    use TopQueryFilterResolver;
+    use TopQueryFilterResolver, TopMediaQueryParameterSanitizer;
+    protected array $parameterNames = ["producer", "producers", "rating", "filter"];
 
     public function __construct(bool $searchIndexesEnabled, ScoutSearchService $scoutSearchService)
     {
         parent::__construct($searchIndexesEnabled, $scoutSearchService);
-        $this->filterMap = ['airing', 'upcoming', 'bypopularity', 'favorite'];
+        $this->filterMap = ["airing", "upcoming", "bypopularity", "favorite"];
+    }
+
+    protected function sanitizeParameters(Collection $parameters): Collection
+    {
+        return parent::sanitizeParameters($this->sanitizeTopMediaParameters($parameters));
     }
 
     protected function buildQuery(Collection $requestParameters, \Illuminate\Database\Eloquent\Builder|\Laravel\Scout\Builder $results): \Laravel\Scout\Builder|\Illuminate\Database\Eloquent\Builder
     {
         $builder = parent::buildQuery($requestParameters, $results);
-        $filterType = $this->mapFilter($requestParameters->get("filter"));
-
-        // MAL formula:
-        // Top All Anime sorted by rank
-        // Top Airing sorted by rank
-        // Top TV, Movie, OVA, ONA, Specials ordered by rank
-        // Top Upcoming ordered by members
-        // Most popular ordered by members
-        // Most favorites ordered by most favorites
-
-        $builder = $builder->where("rating", "!=", $this->getAdultRating());
-
-        return match ($filterType) {
-            "airing" => $builder
-                ->where("airing", true)
-                ->whereNotNull("rank")
-                ->where("rank", ">", 0)
-                ->orderBy("rank", "asc"),
-            "upcoming" => $builder
-                ->where('airing', true)
-                ->whereNotNull('rank')
-                ->where('rank', '>', 0)
-                ->orderBy('rank', 'asc'),
-            "bypopularity" => $builder
-                ->orderBy('members', 'desc'),
-            "favorite" => $builder
-                ->orderBy('favorites', 'desc'),
-            default => $builder
-                ->whereNotNull('rank')
-                ->where('rank', '>', 0)
-                ->orderBy('rank', 'asc'),
-        };
+        return $this->applyFilterParameter($requestParameters, $builder, false);
     }
 
     public function getIdentifier(): string

@@ -2,42 +2,31 @@
 
 namespace App\Http\QueryBuilder;
 
+use App\Http\QueryBuilder\Traits\TopMediaQueryParameterSanitizer;
 use App\Http\QueryBuilder\Traits\TopQueryFilterResolver;
 use App\Services\ScoutSearchService;
 use Illuminate\Support\Collection;
 
 class TopMangaQueryBuilder extends MangaSearchQueryBuilder
 {
-    use TopQueryFilterResolver;
+    use TopQueryFilterResolver, TopMediaQueryParameterSanitizer;
+    protected array $parameterNames = ["magazine", "magazines", "rating", "filter"];
 
     public function __construct(bool $searchIndexesEnabled, ScoutSearchService $scoutSearchService)
     {
         parent::__construct($searchIndexesEnabled, $scoutSearchService);
-        $this->filterMap = ['publishing', 'upcoming', 'bypopularity', 'favorite'];
+        $this->filterMap = ["publishing", "upcoming", "bypopularity", "favorite"];
+    }
+
+    protected function sanitizeParameters(Collection $parameters): Collection
+    {
+        return parent::sanitizeParameters($this->sanitizeTopMediaParameters($parameters));
     }
 
     protected function buildQuery(Collection $requestParameters, \Illuminate\Database\Eloquent\Builder|\Laravel\Scout\Builder $results): \Laravel\Scout\Builder|\Illuminate\Database\Eloquent\Builder
     {
         $builder = parent::buildQuery($requestParameters, $results);
-        $filterType = $this->mapFilter($requestParameters->get("filter"));
-
-        $builder = $builder->where("rating", "!=", $this->getAdultRating());
-
-        return match ($filterType) {
-            "publishing" => $builder
-                ->where("publishing", true)
-                ->whereNotNull("rank")
-                ->where("rank", ">", 0)
-                ->orderBy("rank", "asc"),
-            "bypopularity" => $builder
-                ->orderBy('members', 'desc'),
-            "favorite" => $builder
-                ->orderBy('favorites', 'desc'),
-            default => $builder
-                ->whereNotNull('rank')
-                ->where('rank', '>', 0)
-                ->orderBy('rank', 'asc'),
-        };
+        return $this->applyFilterParameter($requestParameters, $builder, true);
     }
 
     public function getIdentifier(): string

@@ -0,0 +1,19 @@
+<?php
+namespace App\Http\QueryBuilder\Traits;
+
+use Illuminate\Support\Collection;
+
+trait TopMediaQueryParameterSanitizer
+{
+    protected function sanitizeTopMediaParameters(Collection $parameters): Collection
+    {
+        $unwanted_params = ["status", "q", "letter"];
+        foreach ($unwanted_params as $paramName) {
+            if ($parameters->offsetExists($paramName)) {
+                $parameters->offsetUnset($paramName);
+            }
+        }
+
+        return $parameters;
+    }
+}
@@ -2,6 +2,8 @@
 
 namespace App\Http\QueryBuilder\Traits;
 
+use Illuminate\Support\Collection;
+
 trait TopQueryFilterResolver
 {
     protected array $filterMap = [];
@@ -16,4 +18,44 @@ private function mapFilter(?string $filter = null) : ?string
 
         return $filter;
     }
+
+    private function applyFilterParameter(Collection $requestParameters, \Illuminate\Database\Eloquent\Builder|\Laravel\Scout\Builder $builder, bool $is_manga): \Illuminate\Database\Eloquent\Builder|\Laravel\Scout\Builder
+    {
+        $filterType = $this->mapFilter($requestParameters->get("filter"));
+        $builder = $builder->where("rating", "!=", $this->getAdultRating());
+        $is_running = $is_manga ? "publishing" : "airing";
+
+        if ($filterType === "upcoming" && $is_manga) {
+            $filterType = "";
+        }
+
+        // MAL formula:
+        // Top All Anime sorted by rank
+        // Top Airing sorted by rank
+        // Top TV, Movie, OVA, ONA, Specials ordered by rank
+        // Top Upcoming ordered by members
+        // Most popular ordered by members
+        // Most favorites ordered by most favorites
+
+        return match ($filterType) {
+            $is_running => $builder
+                ->where($is_running, true)
+                ->whereNotNull("rank")
+                ->where("rank", ">", 0)
+                ->orderBy("rank", "asc"),
+            "upcoming" => $builder
+                ->where('airing', true)
+                ->whereNotNull('rank')
+                ->where('rank', '>', 0)
+                ->orderBy('rank', 'asc'),
+            "bypopularity" => $builder
+                ->orderBy('members', 'desc'),
+            "favorite" => $builder
+                ->orderBy('favorites', 'desc'),
+            default => $builder
+                ->whereNotNull('rank')
+                ->where('rank', '>', 0)
+                ->orderBy('rank', 'asc'),
+        };
+    }
 }