feat: allow users to change their names

app/Community/Controllers/UserSettingsController.php

@@ -4,6 +4,7 @@
 
 namespace App\Community\Controllers;
 
+use App\Community\Data\StoreUsernameChangeData;
 use App\Community\Data\UpdateEmailData;
 use App\Community\Data\UpdateLocaleData;
 use App\Community\Data\UpdatePasswordData;
@@ -13,6 +14,7 @@
 use App\Community\Enums\ArticleType;
 use App\Community\Requests\ResetConnectApiKeyRequest;
 use App\Community\Requests\ResetWebApiKeyRequest;
+use App\Community\Requests\StoreUsernameChangeRequest;
 use App\Community\Requests\UpdateEmailRequest;
 use App\Community\Requests\UpdateLocaleRequest;
 use App\Community\Requests\UpdatePasswordRequest;
@@ -24,6 +26,7 @@
 use App\Enums\UserPreference;
 use App\Http\Controller;
 use App\Models\User;
+use App\Models\UserUsername;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Auth;
@@ -49,16 +52,44 @@ public function show(): InertiaResponse
         );
 
         $can = UserPermissionsData::fromUser($user)->include(
+            'createUsernameChangeRequest',
             'manipulateApiKeys',
             'updateAvatar',
             'updateMotto'
         );
 
-        $props = new UserSettingsPagePropsData($userSettings, $can);
+        $requestedUsername = UserUsername::whereUserId($user->id)
+            ->pending()
+            ->latest('created_at')
+            ->first()
+            ?->username;
+
+        $props = new UserSettingsPagePropsData(
+            $userSettings,
+            $can,
+            $requestedUsername
+        );
 
         return Inertia::render('settings', $props);
     }
 
+    public function storeUsernameChangeRequest(StoreUsernameChangeRequest $request): JsonResponse
+    {
+        $this->authorize('create', UserUsername::class);
+
+        $data = StoreUsernameChangeData::fromRequest($request);
+
+        /** @var User $user */
+        $user = $request->user();
+
+        UserUsername::create([
+            'user_id' => $user->id,
+            'username' => $data->newDisplayName,
+        ]);
+
+        return response()->json(['success' => true]);
+    }
+
     public function updatePassword(UpdatePasswordRequest $request): JsonResponse
     {
         $data = UpdatePasswordData::fromRequest($request);

app/Community/Data/StoreUsernameChangeData.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Community\Data;
+
+use App\Community\Requests\StoreUsernameChangeRequest;
+use Spatie\LaravelData\Data;
+
+class StoreUsernameChangeData extends Data
+{
+    public function __construct(
+        public string $newDisplayName
+    ) {
+    }
+
+    public static function fromRequest(StoreUsernameChangeRequest $request): self
+    {
+        return new self(
+            newDisplayName: $request->newDisplayName,
+        );
+    }
+}

app/Community/Data/UserSettingsPagePropsData.php

@@ -15,6 +15,7 @@ class UserSettingsPagePropsData extends Data
     public function __construct(
         public UserData $userSettings,
         public UserPermissionsData $can,
+        public ?string $requestedUsername = null,
     ) {
     }
 }

app/Community/Requests/StoreUsernameChangeRequest.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Community\Requests;
+
+use App\Support\Rules\ValidNewUsername;
+use Illuminate\Foundation\Http\FormRequest;
+
+class StoreUsernameChangeRequest extends FormRequest
+{
+    public function rules(): array
+    {
+        return [
+            'newDisplayName' => ValidNewUsername::get($this->user()),
+        ];
+    }
+}

app/Community/RouteServiceProvider.php

@@ -366,6 +366,9 @@ protected function mapWebRoutes(): void
                     Route::put('password', [UserSettingsController::class, 'updatePassword'])->name('api.settings.password.update');
                     Route::put('email', [UserSettingsController::class, 'updateEmail'])->name('api.settings.email.update');
 
+                    Route::post('username-change-request', [UserSettingsController::class, 'storeUsernameChangeRequest'])
+                        ->name('api.settings.username-change-request.store');
+
                     Route::delete('keys/web', [UserSettingsController::class, 'resetWebApiKey'])->name('api.settings.keys.web.destroy');
                     Route::delete('keys/connect', [UserSettingsController::class, 'resetConnectApiKey'])->name('api.settings.keys.connect.destroy');
                 });

app/Data/UserPermissionsData.php

@@ -16,6 +16,7 @@ class UserPermissionsData extends Data
 {
     public function __construct(
         public Lazy|bool $createTriggerTicket,
+        public Lazy|bool $createUsernameChangeRequest,
         public Lazy|bool $develop,
         public Lazy|bool $manageGameHashes,
         public Lazy|bool $manageGameSets,
@@ -35,6 +36,7 @@ public static function fromUser(
                 ? $user->can('createFor', [\App\Models\TriggerTicket::class, $triggerable])
                 : $user?->can('create', \App\Models\TriggerTicket::class) ?? false
             ),
+            createUsernameChangeRequest: Lazy::create(fn () => $user ? $user->can('create', \App\Models\UserUsername::class) : false),
             develop: Lazy::create(fn () => $user ? $user->can('develop') : false),
             manageGameHashes: Lazy::create(fn () => $user ? $user->can('manage', \App\Models\GameHash::class) : false),
             manageGameSets: Lazy::create(fn () => $user ? $user->can('manage', \App\Models\GameSet::class) : false),

app/Filament/Resources/UserUsernameResource.php

@@ -0,0 +1,128 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Filament\Resources;
+
+use App\Filament\Extensions\Resources\Resource;
+use App\Filament\Resources\UserUsernameResource\Pages;
+use App\Models\User;
+use App\Models\UserUsername;
+use Filament\Forms\Form;
+use Filament\Notifications\Notification;
+use Filament\Tables;
+use Filament\Tables\Table;
+
+class UserUsernameResource extends Resource
+{
+    protected static ?string $model = UserUsername::class;
+
+    protected static ?int $navigationSort = 30;
+
+    protected static ?string $navigationIcon = 'heroicon-s-wrench';
+
+    protected static ?string $navigationGroup = 'Tools';
+
+    protected static ?string $navigationLabel = 'Username Change Requests';
+
+    protected static ?string $modelLabel = 'Username Change Request';
+
+    public static function getNavigationBadge(): ?string
+    {
+        $count = static::getModel()::pending()->count();
+
+        return "{$count}";
+    }
+
+    public static function getNavigationBadgeColor(): ?string
+    {
+        return static::getNavigationBadge() > 0 ? 'warning' : null;
+    }
+
+    public static function form(Form $form): Form
+    {
+        return $form
+            ->schema([
+
+            ]);
+    }
+
+    public static function table(Table $table): Table
+    {
+        return $table
+            ->columns([
+                Tables\Columns\TextColumn::make('user.display_name')
+                    ->label('Current Username')
+                    ->url(fn (UserUsername $record) => UserResource::getUrl('view', ['record' => $record->user->display_name]))
+                    ->extraAttributes(['class' => 'underline'])
+                    ->openUrlInNewTab()
+                    ->searchable()
+                    ->sortable(),
+
+                Tables\Columns\TextColumn::make('username')
+                    ->label('Requested New Username')
+                    ->searchable()
+                    ->sortable(),
+
+                Tables\Columns\TextColumn::make('created_at')
+                    ->label('Requested At')
+                    ->dateTime()
+                    ->sortable(),
+            ])
+            ->defaultSort('created_at', 'desc')
+            ->filters([
+                Tables\Filters\TernaryFilter::make('is_approved')
+                    ->queries(
+                        true: fn ($query) => $query->whereNotNull('approved_at'),
+                        false: fn ($query) => $query->whereNull('approved_at'),
+                    )
+                    ->default(false),
+            ])
+            ->actions([
+                Tables\Actions\Action::make('approve')
+                    ->action(function (UserUsername $record) {
+                        $record->update(['approved_at' => now()]);
+
+                        /** @var User $user */
+                        $user = $record->user;
+
+                        $originalDisplayName = $user->display_name;
+
+                        $user->display_name = $record->username;
+                        $user->save();
+
+                        sendDisplayNameChangeConfirmationEmail($user, $record->username);
+
+                        Notification::make()
+                            ->success()
+                            ->title('Success')
+                            ->body("Approved {$originalDisplayName}'s username change request.")
+                            ->send();
+                    })
+                    ->visible(fn (UserUsername $record) => !$record->is_approved)
+                    ->requiresConfirmation()
+                    ->modalDescription("Are you sure you'd like to do this? The username change will go into effect immediately.")
+                    ->color('success')
+                    ->icon('heroicon-o-check'),
+            ])
+            ->bulkActions([
+                Tables\Actions\BulkActionGroup::make([
+                    Tables\Actions\DeleteBulkAction::make(),
+                ]),
+            ]);
+    }
+
+    public static function getRelations(): array
+    {
+        return [
+
+        ];
+    }
+
+    public static function getPages(): array
+    {
+        return [
+            'index' => Pages\Index::route('/'),
+        ];
+    }
+}

app/Filament/Resources/UserUsernameResource/Pages/Index.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Filament\Resources\UserUsernameResource\Pages;
+
+use App\Filament\Resources\UserUsernameResource;
+use Filament\Resources\Pages\ListRecords;
+
+class Index extends ListRecords
+{
+    protected static string $resource = UserUsernameResource::class;
+
+    protected function getHeaderActions(): array
+    {
+        return [
+
+        ];
+    }
+}

app/Helpers/util/mail.php

@@ -457,3 +457,22 @@ function sendSetRevisionEmail(
 
     return mail_utf8($email, $emailTitle, $msg);
 }
+
+/**
+ * Sends an email to a user informing them that their display name was successfully changed.
+ */
+function sendDisplayNameChangeConfirmationEmail(
+    User $user,
+    string $newDisplayName,
+): bool {
+    $emailTitle = "Username Change Approved";
+    $profileLink = "<a href='" . route('user.show', ['user' => $newDisplayName]) . "'>here</a>";
+
+    $msg = "Hello,<br><br>" .
+        "Great news! Your username change request to {$newDisplayName} has been approved.<br><br>" .
+        "You can now use your new username to log in everywhere on RetroAchievements.org.<br><br>" .
+        "Check out your updated profile {$profileLink}.<br><br>" .
+        "-- Your friends at RetroAchievements.org<br>";
+
+    return mail_utf8($user->EmailAddress, $emailTitle, $msg);
+}

app/Models/UserUsername.php

@@ -0,0 +1,66 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Models;
+
+use App\Support\Database\Eloquent\BaseModel;
+use Illuminate\Database\Eloquent\Builder;
+use Illuminate\Database\Eloquent\Relations\BelongsTo;
+
+class UserUsername extends BaseModel
+{
+    protected $table = 'user_usernames';
+
+    protected $fillable = [
+        'user_id',
+        'username',
+        'approved_at',
+    ];
+
+    protected $casts = [
+        'approved_at' => 'datetime',
+    ];
+
+    protected static function booted(): void
+    {
+        // Username change requests that are more than 30 days old are naturally
+        // filtered out of all requests. These are considered "expired".
+        static::addGlobalScope('hideStaleRequests', function (Builder $builder) {
+            $builder->where(function ($query) {
+                $query->whereNotNull('approved_at')
+                    ->orWhere('created_at', '>', now()->subDays(30));
+            });
+        });
+    }
+
+    // == accessors
+
+    public function getIsApprovedAttribute(): bool
+    {
+        return $this->approved_at !== null;
+    }
+
+    // == mutators
+
+    // == relations
+
+    /**
+     * @return BelongsTo<User, UserUsername>
+     */
+    public function user(): BelongsTo
+    {
+        return $this->belongsTo(User::class, 'user_id', 'ID');
+    }
+
+    // == scopes
+
+    /**
+     * @param Builder<UserUsername> $query
+     * @return Builder<UserUsername>
+     */
+    public function scopePending(Builder $query): Builder
+    {
+        return $query->whereNull('approved_at');
+    }
+}