feat: migrate reorder site awards to inertia

app/Community/Controllers/ReorderSiteAwardsController.php

@@ -0,0 +1,294 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Community\Controllers;
+
+use App\Community\Data\UserAwardData;
+use App\Community\Enums\AwardType;
+use App\Http\Controller;
+use App\Models\Event;
+use App\Models\EventAward;
+use App\Models\PlayerBadge;
+use App\Models\System;
+use App\Models\User;
+use Illuminate\Support\Collection;
+use Inertia\Inertia;
+
+class ReorderSiteAwardsController extends Controller
+{
+    public function index()
+    {
+        $awards = $this->getUsersSiteAwards(request()->user());
+        $cleanAwards = $this->SeparateAwards($awards);
+
+        return Inertia::render('reorder-site-awards')
+            ->with('awards', $cleanAwards);
+    }
+
+    public function getUsersSiteAwards(User $user): array
+    {
+        $bindings = [
+            'userId' => $user->id,
+            'userId2' => $user->id,
+            'userId3' => $user->id,
+        ];
+
+        $gameAwardValues = implode("','", AwardType::gameValues());
+
+        $query = "
+        -- game awards (mastery, beaten)
+        SELECT " . unixTimestampStatement('saw.awarded_at', 'AwardedAt') . ", saw.award_type, saw.user_id, saw.award_key, saw.award_tier, saw.order_column, gd.title AS Title, s.id AS ConsoleID, s.name AS ConsoleName, NULL AS Flags, gd.image_icon_asset_path AS ImageIcon, NULL AS display_award_tier
+            FROM user_awards AS saw
+            LEFT JOIN games AS gd ON ( gd.id = saw.award_key AND saw.award_type IN ('{$gameAwardValues}') )
+            LEFT JOIN systems AS s ON s.id = gd.system_id
+            WHERE
+                saw.award_type IN('{$gameAwardValues}')
+                AND saw.user_id = :userId
+            GROUP BY saw.award_type, saw.award_key, saw.award_tier
+            HAVING
+                -- Remove duplicate game beaten awards.
+                (saw.award_type != '" . AwardType::GameBeaten->value . "' OR saw.award_tier = 1 OR NOT EXISTS (
+                    SELECT 1 FROM user_awards AS saw2
+                    WHERE saw2.award_type = saw.award_type AND saw2.award_key = saw.award_key AND saw2.award_tier = 1 AND saw2.user_id = saw.user_id
+                ))
+                -- Remove duplicate mastery awards.
+                AND (saw.award_type != '" . AwardType::Mastery->value . "' OR saw.award_tier = 1 OR NOT EXISTS (
+                    SELECT 1 FROM user_awards AS saw3
+                    WHERE saw3.award_type = saw.award_type AND saw3.award_key = saw.award_key AND saw3.award_tier = 1 AND saw3.user_id = saw.user_id
+                ))
+        UNION
+        -- event awards
+        SELECT " . unixTimestampStatement('saw.awarded_at', 'AwardedAt') . ", saw.award_type, saw.user_id, saw.award_key, saw.award_tier, saw.order_column, gd.title AS Title, " . System::Events . ", 'Events', NULL, e.image_asset_path AS ImageIcon, saw.display_award_tier
+            FROM user_awards AS saw
+            LEFT JOIN events e ON e.id = saw.award_key
+            LEFT JOIN games gd ON gd.id = e.legacy_game_id
+            WHERE
+                saw.award_type = '" . AwardType::Event->value . "'
+                AND saw.user_id = :userId3
+        UNION
+        -- non-game awards (developer contribution, ...)
+        SELECT " . unixTimestampStatement('MAX(saw.awarded_at)', 'AwardedAt') . ", saw.award_type, saw.user_id, MAX( saw.award_key ), saw.award_tier, saw.order_column, NULL, NULL, NULL, NULL, NULL, NULL
+            FROM user_awards AS saw
+            WHERE
+                saw.award_type NOT IN('{$gameAwardValues}','" . AwardType::Event->value . "')
+                AND saw.user_id = :userId2
+            GROUP BY saw.award_type
+        ORDER BY order_column, AwardedAt, award_type, award_tier ASC";
+
+        // TODO: Don't use legacy
+        $dbResult = legacyDbFetchAll($query, $bindings)->toArray();
+
+        foreach ($dbResult as &$award) {
+            // dd($dbResult);
+
+            unset($award['user_id']);
+
+            $award['AwardType'] = AwardType::from($award['award_type']);
+            $award['AwardData'] = (int) $award['award_key'];
+            $award['AwardDataExtra'] = (int) $award['award_tier'];
+            $award['DisplayOrder'] = (int) $award['order_column'];
+
+            if ($award['ConsoleID']) {
+                $award['ConsoleID'] = (int) $award['ConsoleID'];
+            }
+
+            unset($award['award_type'], $award['award_key'], $award['award_tier'], $award['order_column']);
+        }
+
+        return $dbResult;
+    }
+
+    /*
+     * array of ["AwardType" => enum AwardType, AwardData => int, AwardDataExtra => int, DisplayOrder => int, ConsoleID => int?]
+     */
+    /**
+     * Parses awards into a usable state for the frontend.
+     *
+     * @param array $userAwards array of awards from the database.
+     * @return array<UserAwardData>
+     */
+    public function SeparateAwards(array $userAwards): array
+    {
+        $awardEventGameIds = [];
+        $awardEventIds = [];
+        foreach ($userAwards as $award) {
+            $type = $award['AwardType'];
+            if ($type === AwardType::Event) {
+                $awardEventIds[] = (int) $award['AwardData'];
+            } elseif ($award['ConsoleName'] === 'Events' && AwardType::isGame($type)) {
+                $awardEventGameIds[] = (int) $award['AwardData'];
+            }
+        }
+
+        if (! empty($awardEventGameIds)) {
+            $awardEventIds = array_merge($awardEventIds,
+                Event::whereIn('legacy_game_id', $awardEventIds)->select('id')->pluck('id')->toArray()
+            );
+        }
+
+        $eventData = new Collection;
+        $eventAwardData = new Collection;
+        if (! empty($awardEventIds)) {
+            $eventData = Event::whereIn('id', $awardEventIds)->with('legacyGame')->get()->keyBy('id');
+            $eventAwardData = EventAward::whereIn('event_id', $awardEventIds)->get()->groupBy('event_id');
+        }
+
+        $gameAwards = []; // Mastery awards that aren't Events.
+        $eventAwards = []; // Event awards and Events mastery awards.
+        $siteAwards = []; // Dev event awards and non-game active awards.
+
+        /** @var UserAwardData[] $awards */
+        $awards = [];
+
+        foreach ($userAwards as $award) {
+            $type = $award['AwardType'];
+            $id = (int) $award['AwardData'];
+            $extra = (int) $award['AwardDataExtra'];
+            $awardDate = $award['AwardedAt'];
+
+            $section = 'unknown';
+
+            if (AwardType::isGame($type)) {
+                if ($award['ConsoleName'] === 'Events') {
+                    $section = 'event';
+                } elseif ($type !== AwardType::GameBeaten) {
+                    $section = 'game';
+                    $award["ImageIcon"] = asset($award['ImageIcon']);
+                    $gameId = $id;
+
+                    $award["IsGold"] = $extra === 1;
+                }
+            } elseif ($type === AwardType::Event) {
+                if ($eventData[$id]?->gives_site_award) {
+                    $section = 'site';
+                } else {
+                    $section = 'event';
+                }
+
+                $event = $eventData->find($id);
+                if ($event) {
+                    $tooltipTitle = $event->title;
+                    $tooltipDescription = "Awarded for completing this event";
+                    $image = $event->image_asset_path;
+
+                    // Use the display preference for the badge image, but always
+                    // use the actual earned tier for the tooltip text. Otherwise,
+                    // it's very ambiguous what tier the player is actually on if
+                    // they have a saved tier preference.
+                    $displayTier = (int) ($award['display_award_tier'] ?? $extra);
+                    $actualTier = $extra;
+
+                    $tierIndicesToFetch = array_unique([$displayTier, $actualTier]);
+                    $eventAwardsByTier = ($eventAwardData->get($id) ?? collect())
+                        ->whereIn('tier_index', $tierIndicesToFetch)
+                        ->keyBy('tier_index');
+
+                    $displayEventAward = $eventAwardsByTier->get($displayTier);
+                    if ($displayEventAward) {
+                        $image = $displayEventAward->image_asset_path;
+                    }
+
+                    $actualEventAward = $eventAwardsByTier->get($actualTier);
+                    if ($actualEventAward && $actualEventAward->points_required < $event->legacyGame->points_total) {
+                        // Strip the event/game title prefix from the tier label to avoid duplication.
+                        $tierLabel = $actualEventAward->label;
+                        $gameTitle = $event->legacyGame->title ?? '';
+                        if ($tierLabel !== $gameTitle && str_starts_with($tierLabel, $gameTitle)) {
+                            $tierLabel = ltrim(substr($tierLabel, strlen($gameTitle)), ' -:');
+                        }
+
+                        // Only append the tier label if the event title doesn't already contain it.
+                        if (! str_ends_with($event->title, $tierLabel)) {
+                            $tooltipTitle = "$event->title - $tierLabel";
+                        }
+
+                        $tooltipDescription = "Awarded for earning at least $actualEventAward->points_required points";
+                    }
+
+                    $award["Tooltip"] = $tooltipTitle . "<br>" . $tooltipDescription;
+                    $award["ImageIcon"] = media_asset($image);
+                    $award["IsGold"] = true;
+                    $award["Link"] = route('event.show', $event->id);
+                    /* <div class='p-2 max-w-[320px] text-pretty'><span>$tooltip</span><p class='italic'>{$awardDate}</p></div> */
+                    // tooltip: "<div class='p-2 max-w-[320px] text-pretty text-menu-link flex flex-col gap-1'><p class='font-bold'>{$tooltipTitle}</p><span>{$tooltipDescription}</span><p class='italic'>{$awardDate}</p></div>",
+                }
+
+            } elseif (AwardType::isActive($type)) {
+                $this->makeTooltip($award);
+                $section = 'site';
+            }
+
+            if ($section === 'unknown') {
+                continue;
+            }
+
+            $newAward = new UserAwardData(
+                title: $award["Title"],
+                imageUrl: $award['ImageIcon'] ?? '',
+                tooltip: $award['Tooltip'] ?? '',
+                link: $award['Link'] ?? '',
+                isGold: $award['IsGold'] ?? false,
+                gameId: $gameId ?? null,
+                dateAwarded: $award['AwardedAt'] . "",
+                awardType: $award['AwardType'],
+                awardSection: $section,
+                displayOrder: $award['DisplayOrder']
+            );
+
+            $awards[] = $newAward;
+        }
+
+        return $awards;
+    }
+
+    public function makeTooltip(&$award): void
+    {
+        switch ($award['AwardType']) {
+            case AwardType::GameBeaten:
+            case AwardType::Mastery:
+                // no tooltip needed, frontend uses GameAvatar
+                $award['Tooltip'] = null;
+
+                return;
+            case AwardType::AchievementPointsYield:
+                $data = $award["AwardData"];
+                $points = PlayerBadge::getBadgeThreshold(AwardType::AchievementPointsYield, $data);
+                $award['Title'] = "Achievement Points Earned by Others";
+                $award['Tooltip'] = "Awarded for producing many valuable achievements, providing over $points points to the community!";
+                $award["ImageIcon"] = asset("/assets/images/badge/contribPoints-$data.png");
+                $award["IsGold"] = true;
+
+                return;
+            case AwardType::AchievementUnlocksYield:
+                $data = $award["AwardData"];
+                $points = PlayerBadge::getBadgeThreshold(AwardType::AchievementUnlocksYield, $data);
+                $award["Title"] = "Achievements Earned by Others";
+                $award['Tooltip'] = "Awarded for being a hard-working developer and producing achievements that have been earned over $points times!";
+                $award["ImageIcon"] = asset("/assets/images/badge/contribYield-$data.png");
+                $award["IsGold"] = true;
+
+                return;
+
+            case AwardType::CertifiedLegend:
+                $award["Title"] = "Certified Legend";
+                $award['Tooltip'] = 'Specially Awarded to a Certified RetroAchievements Legend';
+                $award["ImageIcon"] = asset('/assets/images/badge/legend.png');
+                $award["IsGold"] = true;
+
+                return;
+            case AwardType::PatreonSupporter:
+                $award["Title"] = "Patreon Supporter";
+                $award['Tooltip'] = 'Awarded for being a Patreon supporter! Thank-you so much for your support!';
+                $award["ImageIcon"] = asset('/assets/images/badge/patreon.png');
+                $award["IsGold"] = true;
+                $award["Link"] = route('patreon-supporter.index');
+
+                return;
+            case AwardType::Event:
+                $award['Tooltip'] = 'Event Award';
+
+                return;
+        }
+    }
+}

app/Community/Data/UserAwardData.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Community\Data;
+
+use App\Community\Enums\AwardType;
+use Spatie\LaravelData\Data;
+use Spatie\TypeScriptTransformer\Attributes\TypeScript;
+
+#[TypeScript('UserAwardData')]
+class UserAwardData extends Data
+{
+    public function __construct(
+        public string $title,
+        public string $imageUrl,
+        public string $tooltip,
+        public ?string $link,
+        public bool $isGold,
+        public ?int $gameId,
+        public string $dateAwarded,
+        public AwardType $awardType,
+        public string $awardSection,
+        public int $displayOrder,
+    ) {}
+}

app/Community/RouteServiceProvider.php

@@ -37,6 +37,7 @@
 use App\Community\Controllers\LeaderboardCommentController;
 use App\Community\Controllers\MessageThreadController;
 use App\Community\Controllers\PatreonSupportersController;
+use App\Community\Controllers\ReorderSiteAwardsController;
 use App\Community\Controllers\UnsubscribeController;
 use App\Community\Controllers\UserAchievementChecklistController;
 use App\Community\Controllers\UserCommentController;
@@ -145,6 +146,8 @@ protected function mapWebRoutes(): void
                         Route::get('messages/{user}/create', [MessageThreadController::class, 'create'])->name('message-thread.user.create');
 
                         Route::get('settings', [UserSettingsController::class, 'show'])->name('settings.show');
+
+                        Route::get('reorder-site-awards', [ReorderSiteAwardsController::class, 'index'])->name('reorder-site-awards.index');
                     });
                 });
 

lang/en_US.json

@@ -1309,6 +1309,7 @@
     "Save": "Save",
     "Saving...": "Saving...",
     "Saved!": "Saved!",
+    "Save All Changes": "Save All Changes",
     "<1>If subsets aren't working or if every subset still requires a patch</1>, make sure you're using the latest version of your emulator. If you're using RetroArch, make absolutely sure the emulator version is 1.22.1 or higher. Updating the RetroArch cores alone is not sufficient.": "<1>If subsets aren't working or if every subset still requires a patch</1>, make sure you're using the latest version of your emulator. If you're using RetroArch, make absolutely sure the emulator version is 1.22.1 or higher. Updating the RetroArch cores alone is not sufficient.",
     "Opted In": "Opted In",
     "Opted Out": "Opted Out",

package.json

@@ -25,6 +25,8 @@
         "@bbob/plugin-helper": "^4.2.0",
         "@bbob/preset-react": "^4.2.0",
         "@bbob/react": "^4.2.0",
+        "@dnd-kit/helpers": "^0.3.2",
+        "@dnd-kit/react": "^0.3.2",
         "@floating-ui/core": "^1.6.8",
         "@floating-ui/dom": "^1.5.1",
         "@hookform/resolvers": "^5.0.1",