feat: Add ability to pick preferred locale for a user (#187)

Author: danjohnson95

config/cachet.php

@@ -126,4 +126,17 @@
             'prune_logs_after_days' => 30,
         ],
     ],
+
+    /*
+     |--------------------------------------------------------------------------
+     | Cachet Supported Locales
+     |--------------------------------------------------------------------------
+     |
+     | Configure which locales are supported by Cachet.
+     |
+     */
+    'supported_locales' => [
+        'en' => 'English',
+        'en_GB' => 'English (UK)',
+    ],
 ];

database/migrations/2025_01_16_225001_add_locale_to_user.php

@@ -0,0 +1,28 @@
+<?php
+
+use Illuminate\Database\Migrations\Migration;
+use Illuminate\Database\Schema\Blueprint;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    /**
+     * Run the migrations.
+     */
+    public function up(): void
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->string('preferred_locale')->nullable();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void
+    {
+        Schema::table('users', function (Blueprint $table) {
+            $table->dropColumn('preferred_locale');
+        });
+    }
+};

resources/lang/en/user.php

@@ -22,6 +22,8 @@
         'email_label' => 'Email Address',
         'password_label' => 'Password',
         'password_confirmation_label' => 'Confirm Password',
+        'preferred_locale' => 'Preferred Locale',
+        'preferred_locale_system_default' => 'System Default',
         'is_admin_label' => 'Admin',
     ],
 ];

src/CachetDashboardServiceProvider.php

@@ -2,6 +2,7 @@
 
 namespace Cachet;
 
+use Cachet\Http\Middleware\SetAppLocale;
 use Filament\Http\Middleware\Authenticate;
 use Filament\Http\Middleware\DisableBladeIconComponents;
 use Filament\Http\Middleware\DispatchServingFilamentEvent;
@@ -86,6 +87,7 @@ public function panel(Panel $panel): Panel
                 SubstituteBindings::class,
                 DisableBladeIconComponents::class,
                 DispatchServingFilamentEvent::class,
+                SetAppLocale::class,
             ])
             ->authMiddleware([
                 Authenticate::class,

src/Filament/Resources/UserResource.php

@@ -56,6 +56,14 @@ public static function form(Form $form): Form
                         ->same('password')
                         ->label(__('cachet::user.form.password_confirmation_label')),
 
+                    Forms\Components\Select::make('preferred_locale')
+                        ->selectablePlaceholder(false)
+                        ->options([
+                            null => __('cachet::user.form.preferred_locale_system_default'),
+                            ...config('cachet.supported_locales')
+                        ])
+                        ->label(__('cachet::user.form.preferred_locale')),
+
                     Forms\Components\Toggle::make('is_admin')
                         ->label(__('cachet::user.form.is_admin_label'))
                         ->disabled(fn (?User $record) => $record?->is(auth()->user())),

src/Http/Middleware/SetAppLocale.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Cachet\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+
+class SetAppLocale
+{
+    public function handle(Request $request, Closure $next)
+    {
+        /** @var ?\Cachet\Models\User */
+        $user = $request->user();
+
+        if ($user) {
+            app()->setLocale($user->preferredLocale() ?? $request->getPreferredLanguage(
+                array_keys(config('cachet.supported_locales'))
+            ));
+        }
+
+        return $next($request);
+    }
+}

src/Models/User.php

@@ -5,6 +5,7 @@
 use Cachet\Concerns\CachetUser;
 use Cachet\Database\Factories\UserFactory;
 use Illuminate\Contracts\Auth\MustVerifyEmail;
+use Illuminate\Contracts\Translation\HasLocalePreference;
 use Illuminate\Database\Eloquent\Factories\Factory;
 use Illuminate\Database\Eloquent\Factories\HasFactory;
 use Illuminate\Foundation\Auth\User as Authenticatable;
@@ -17,8 +18,9 @@
  * @property string $email
  * @property string $password
  * @property bool $is_admin
+ * @property string $preferred_locale
  */
-class User extends Authenticatable implements CachetUser, MustVerifyEmail
+class User extends Authenticatable implements CachetUser, MustVerifyEmail, HasLocalePreference
 {
     /** @use HasFactory<\Cachet\Database\Factories\UserFactory> */
     use HasApiTokens, HasFactory, Notifiable;
@@ -33,6 +35,7 @@ class User extends Authenticatable implements CachetUser, MustVerifyEmail
         'email',
         'password',
         'is_admin',
+        'preferred_locale',
     ];
 
     /**
@@ -74,4 +77,9 @@ protected static function newFactory(): Factory
     {
         return UserFactory::new();
     }
+
+    public function preferredLocale()
+    {
+        return $this->preferred_locale;
+    }
 }