Add seasons infrastructure and basic display

app/Http/Controllers/SeasonsController.php

@@ -0,0 +1,47 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+namespace App\Http\Controllers;
+
+use App\Models\Multiplayer\Room;
+use App\Models\Season;
+use App\Transformers\RankingSelectOptionTransformer;
+use App\Transformers\SeasonTransformer;
+
+class SeasonsController extends Controller
+{
+    public function rooms($id)
+    {
+        $params = $this->paramsForResponse($id, request()->all());
+        $roomsJson = Room::responseJson($params);
+
+        return $roomsJson;
+    }
+
+    public function show($id)
+    {
+        $season = Season::latestOrId($id);
+
+        $params = $this->paramsForResponse($season->getKey());
+        $roomsJson = Room::responseJson($params);
+
+        $seasonJson = json_item($season, new SeasonTransformer());
+
+        $seasons = Season::orderByDesc('id')->get();
+        $seasonsJson = json_collection($seasons, new RankingSelectOptionTransformer());
+
+        return ext_view('seasons.show', compact('roomsJson', 'season', 'seasonJson', 'seasonsJson'));
+    }
+
+    private function paramsForResponse(int $seasonId, ?array $rawParams = null)
+    {
+        return [
+            'cursor' => cursor_from_params($rawParams),
+            'limit' => get_int($rawParams['limit'] ?? null),
+            'mode' => 'all',
+            'season_id' => $seasonId,
+        ];
+    }
+}

app/Http/Controllers/Users/MultiplayerController.php

@@ -8,8 +8,6 @@
 use App\Http\Controllers\Controller;
 use App\Libraries\User\FindForProfilePage;
 use App\Models\Multiplayer\Room;
-use App\Models\User;
-use App\Transformers\Multiplayer\RoomTransformer;
 use App\Transformers\UserTransformer;
 
 class MultiplayerController extends Controller
@@ -25,10 +23,14 @@ public function index($userId, $typeGroup)
         $rawParams = request()->all();
         $params = [
             'cursor' => cursor_from_params($rawParams),
-            'limit' => get_int($params['limit'] ?? null),
+            'limit' => get_int($rawParams['limit'] ?? null),
+            'mode' => 'participated',
+            'sort' => 'ended',
+            'type_group' => $typeGroup,
+            'user' => $user,
         ];
 
-        $json = $this->getJson($user, $params, $typeGroup);
+        $json = Room::responseJson($params);
 
         if (is_json_request()) {
             return $json;
@@ -42,33 +44,4 @@ public function index($userId, $typeGroup)
 
         return ext_view('users.multiplayer.index', compact('json', 'jsonUser', 'user'));
     }
-
-    private function getJson(User $user, array $params, string $typeGroup)
-    {
-        $limit = clamp($params['limit'] ?? 50, 1, 50);
-
-        $search = Room::search([
-            'cursor' => $params['cursor'],
-            'user' => $user,
-            'limit' => $limit,
-            'mode' => 'participated',
-            'sort' => 'ended',
-            'type_group' => $typeGroup,
-        ]);
-
-        [$rooms, $hasMore] = $search['query']->with([
-            'playlist.beatmap',
-            'host',
-        ])->getWithHasMore();
-        $rooms->each->findAndSetCurrentPlaylistItem();
-        $rooms->loadMissing('currentPlaylistItem.beatmap.beatmapset');
-
-        $nextCursor = $hasMore ? $search['cursorHelper']->next($rooms) : null;
-
-        return array_merge([
-            'rooms' => json_collection($rooms, new RoomTransformer(), ['current_playlist_item.beatmap.beatmapset', 'difficulty_range', 'host', 'playlist_item_stats']),
-            'search' => $search['search'],
-            'type_group' => $typeGroup,
-        ], cursor_for_response($nextCursor));
-    }
 }

app/Libraries/RouteSection.php

@@ -97,6 +97,9 @@ class RouteSection
             'scores_controller' => [
                 '_' => 'beatmaps',
             ],
+            'seasons_controller' => [
+                '_' => 'rankings',
+            ],
             'sessions_controller' => [
                 '_' => 'user',
             ],

app/Models/Multiplayer/Room.php

@@ -10,9 +10,12 @@
 use App\Models\Beatmap;
 use App\Models\Chat\Channel;
 use App\Models\Model;
+use App\Models\Season;
+use App\Models\SeasonRoom;
 use App\Models\Traits\WithDbCursorHelper;
 use App\Models\User;
 use App\Traits\Memoizes;
+use App\Transformers\Multiplayer\RoomTransformer;
 use Carbon\Carbon;
 use Ds\Set;
 use Illuminate\Database\Eloquent\Collection;
@@ -33,6 +36,7 @@
  * @property int $participant_count
  * @property \Illuminate\Database\Eloquent\Collection $playlist PlaylistItem
  * @property \Illuminate\Database\Eloquent\Collection $scores Score
+ * @property-read Collection<\App\Models\Season> $seasons
  * @property \Carbon\Carbon $starts_at
  * @property \Carbon\Carbon|null $updated_at
  * @property int $user_id
@@ -103,18 +107,46 @@ public static function preloadRecentParticipants(Collection $rooms)
         }
     }
 
-    public static function search(array $rawParams)
+    public static function responseJson(array $rawParams): array
+    {
+        $typeGroup = $rawParams['type_group'] ?? null;
+
+        $search = static::search($rawParams, 50);
+
+        [$rooms, $hasMore] = $search['query']->with([
+            'playlist.beatmap',
+            'host',
+        ])->getWithHasMore();
+
+        $rooms->each->findAndSetCurrentPlaylistItem();
+        $rooms->loadMissing('currentPlaylistItem.beatmap.beatmapset');
+
+        $response['rooms'] = json_collection($rooms, new RoomTransformer(), ['current_playlist_item.beatmap.beatmapset', 'difficulty_range', 'host', 'playlist_item_stats']);
+
+        if ($typeGroup !== null) {
+            $response['type_group'] = $typeGroup;
+        }
+
+        $nextCursor = $hasMore ? $search['cursorHelper']->next($rooms) : null;
+
+        return array_merge($response, cursor_for_response($nextCursor));
+    }
+
+    public static function search(array $rawParams, ?int $maxLimit = null)
     {
         $params = get_params($rawParams, null, [
             'category',
             'limit:int',
             'mode',
+            'season_id:int',
             'sort',
             'type_group',
             'user:any',
         ], ['null_missing' => true]);
 
+        $maxLimit ??= 250;
         $user = $params['user'];
+        $seasonId = $params['season_id'];
         $sort = $params['sort'];
         $category = $params['category'];
         $typeGroup = $params['type_group'];
@@ -132,11 +164,17 @@ public static function search(array $rawParams)
 
         $query = static::whereIn('type', static::TYPE_GROUPS[$typeGroup]);
 
+        if (isset($seasonId)) {
+            $query->whereRelation('seasons', 'seasons.id', $seasonId);
+        }
+
         if (in_array($category, static::CATEGORIES, true)) {
             $query->where('category', $category);
         }
 
         switch ($params['mode']) {
+            case 'all':
+                break;
             case 'ended':
                 $query->ended();
                 $sort ??= 'ended';
@@ -154,7 +192,7 @@ public static function search(array $rawParams)
         $cursorHelper = static::makeDbCursorHelper($sort);
         $query->cursorSort($cursorHelper, cursor_from_params($rawParams));
 
-        $limit = clamp($params['limit'] ?? 250, 1, 250);
+        $limit = clamp($params['limit'] ?? $maxLimit, 1, $maxLimit);
         $query->limit($limit);
 
         return [
@@ -192,6 +230,11 @@ public function scores()
         return $this->hasMany(Score::class);
     }
 
+    public function seasons()
+    {
+        return $this->belongsToMany(Season::class, SeasonRoom::class);
+    }
+
     public function userHighScores()
     {
         return $this->hasMany(UserScoreAggregate::class);

app/Models/Season.php

@@ -0,0 +1,57 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use Carbon\Carbon;
+use Illuminate\Database\Eloquent\ModelNotFoundException;
+use Illuminate\Database\Eloquent\Relations\BelongsToMany;
+
+/**
+ * @property bool $finalised
+ * @property string $name
+ * @property-read Collection<Multiplayer\Room> $rooms
+ * @property string|null $url
+ */
+class Season extends Model
+{
+    protected $casts = [
+        'finalised' => 'boolean',
+    ];
+
+    public static function latestOrId($id)
+    {
+        if ($id === 'latest') {
+            $season = static::last();
+
+            if ($season === null) {
+                throw new ModelNotFoundException();
+            }
+        } else {
+            $season = static::findOrFail($id);
+        }
+
+        return $season;
+    }
+
+    public function endDate(): ?Carbon
+    {
+        return $this->finalised
+            ? $this->rooms->max('ends_at')
+            : null;
+    }
+
+    public function startDate(): ?Carbon
+    {
+        return $this->rooms->min('starts_at');
+    }
+
+    public function rooms(): BelongsToMany
+    {
+        return $this->belongsToMany(Multiplayer\Room::class, SeasonRoom::class);
+    }
+}

app/Models/SeasonRoom.php

@@ -0,0 +1,20 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @property int $id
+ * @property int $room_id
+ * @property int $season_id
+ */
+class SeasonRoom extends Model
+{
+    public $timestamps = false;
+}

app/Transformers/RankingSelectOptionTransformer.php

@@ -0,0 +1,22 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace App\Transformers;
+
+use App\Models\Multiplayer\Room;
+use App\Models\Season;
+
+class RankingSelectOptionTransformer extends TransformerAbstract
+{
+    public function transform(Room|Season $item): array
+    {
+        return [
+            'id' => $item->getKey(),
+            'name' => $item->name,
+        ];
+    }
+}

app/Transformers/SeasonTransformer.php

@@ -0,0 +1,24 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace App\Transformers;
+
+use App\Models\Season;
+
+class SeasonTransformer extends TransformerAbstract
+{
+    public function transform(Season $season): array
+    {
+        return [
+            'end_date' => $season->endDate(),
+            'id' => $season->getKey(),
+            'name' => $season->name,
+            'room_count' => $season->rooms()->count(),
+            'start_date' => $season->startDate(),
+        ];
+    }
+}

app/helpers.php

@@ -1076,6 +1076,7 @@ function nav_links()
         'rankings.type.score' => route('rankings', ['mode' => $defaultMode, 'type' => 'score']),
         'rankings.type.country' => route('rankings', ['mode' => $defaultMode, 'type' => 'country']),
         'rankings.type.multiplayer' => route('multiplayer.rooms.show', ['room' => 'latest']),
+        'rankings.type.seasons' => route('seasons.show', ['season' => 'latest']),
         'layout.menu.rankings.kudosu' => osu_url('rankings.kudosu'),
     ];
     $links['community'] = [

database/factories/SeasonFactory.php

@@ -0,0 +1,28 @@
+<?php
+
+// Copyright (c) ppy Pty Ltd <[email protected]>. Licensed under the GNU Affero General Public License v3.0.
+// See the LICENCE file in the repository root for full licence text.
+
+declare(strict_types=1);
+
+namespace Database\Factories;
+
+use App\Models\Season;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+class SeasonFactory extends Factory
+{
+    protected $model = Season::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array
+     */
+    public function definition(): array
+    {
+        return [
+            'name' => $this->faker->sentence(),
+        ];
+    }
+}