User Device (#514)

mooxbot · mooxbot · commit 201302445aad · 2024-04-24T11:38:22.000Z
diff --git a/composer.json b/composer.json
@@ -17,6 +17,7 @@
         }
     ],
     "require": {
+        "jenssegers/agent": "*",
         "moox/core": "*"
     },
     "autoload": {
diff --git a/config/user-device.php b/config/user-device.php
@@ -2,4 +2,8 @@
 
 return [
     'navigation_sort' => 2001,
+    'user_models' => [
+        'App Users' => \App\Models\User::class,
+        'Moox Users' => \Moox\User\Models\User::class,
+    ],
 ];
diff --git a/database/geoip/GeoLite2-ASN.mmdb b/database/geoip/GeoLite2-ASN.mmdb
diff --git a/database/geoip/GeoLite2-City.mmdb b/database/geoip/GeoLite2-City.mmdb
diff --git a/database/geoip/GeoLite2-Country.mmdb b/database/geoip/GeoLite2-Country.mmdb
diff --git a/database/migrations/create_user_devices_table.php.stub b/database/migrations/create_user_devices_table.php.stub
@@ -5,20 +5,23 @@ use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Support\Facades\Schema;
 use Illuminate\Support\Str;
 
-class new class extends Migration
+return new class extends Migration
 {
     public function up()
     {
         Schema::create('user_devices', function (Blueprint $table) {
             $table->id();
             $table->string('title');
             $table->string('slug')->unique();
-            $table->morphs('user');
+            $table->unsignedBigInteger('user_id');
+            $table->string('user_type');
             $table->string('user_agent')->nullable();
             $table->string('os')->nullable();
             $table->string('browser')->nullable();
+            $table->string('platform')->nullable();
             $table->string('country')->nullable();
-            $table->string('location')->nullable();
+            $table->string('city')->nullable();
+            $table->json('location')->nullable();
             $table->boolean('whitelisted')->default(false);
             $table->boolean('active')->default(false);
             $table->ipAddress('ip_address')->nullable();
@@ -30,4 +33,4 @@ class new class extends Migration
     {
         Schema::dropIfExists('user_devices');
     }
-}
+};
diff --git a/resources/lang/de/translations.php b/resources/lang/de/translations.php
@@ -7,7 +7,6 @@
     'title' => 'Device',
     'navigation_label' => 'User Device',
     'navigation_group' => 'Moox User',
-    'title' => 'Title',
     'created_at' => 'Created at',
     'active' => 'active',
 ];
diff --git a/resources/lang/en/translations.php b/resources/lang/en/translations.php
@@ -7,7 +7,6 @@
     'title' => 'Device',
     'navigation_label' => 'User Device',
     'navigation_group' => 'Moox User',
-    'title' => 'Title',
     'created_at' => 'Created at',
     'active' => 'active',
 ];
diff --git a/resources/lang/es/translations.php b/resources/lang/es/translations.php
@@ -7,7 +7,6 @@
     'title' => 'Device',
     'navigation_label' => 'User Device',
     'navigation_group' => 'Moox User',
-    'title' => 'Title',
     'created_at' => 'Created at',
     'active' => 'active',
 ];
diff --git a/resources/lang/hr/translations.php b/resources/lang/hr/translations.php
@@ -7,7 +7,6 @@
     'title' => 'Device',
     'navigation_label' => 'User Device',
     'navigation_group' => 'Moox User',
-    'title' => 'Title',
     'created_at' => 'Created at',
     'active' => 'active',
 ];
diff --git a/resources/lang/nb_NO/translations.php b/resources/lang/nb_NO/translations.php
@@ -7,7 +7,6 @@
     'title' => 'Device',
     'navigation_label' => 'User Device',
     'navigation_group' => 'Moox User',
-    'title' => 'Title',
     'created_at' => 'Created at',
     'active' => 'active',
 ];
diff --git a/resources/lang/ru/translations.php b/resources/lang/ru/translations.php
@@ -7,7 +7,6 @@
     'title' => 'Device',
     'navigation_label' => 'User Device',
     'navigation_group' => 'Moox User',
-    'title' => 'Title',
     'created_at' => 'Created at',
     'active' => 'active',
 ];
diff --git a/src/Commands/InstallCommand.php b/src/Commands/InstallCommand.php
@@ -20,7 +20,7 @@ class InstallCommand extends Command
      *
      * @var string
      */
-    protected $signature = 'mooxuser-device:install';
+    protected $signature = 'mooxuserdevice:install';
 
     /**
      * The console command description.
diff --git a/src/Listeners/StoreUserDevice.php b/src/Listeners/StoreUserDevice.php
@@ -0,0 +1,69 @@
+<?php
+
+namespace Moox\UserDevice\Listeners;
+
+use GeoIp2\Database\Reader;
+use Illuminate\Auth\Events\Login;
+use Illuminate\Http\Request;
+use Illuminate\Support\Str;
+use Jenssegers\Agent\Agent;
+use Moox\UserDevice\Models\UserDevice;
+use Moox\UserDevice\Services\LocationService;
+
+class StoreUserDevice
+{
+    protected $request;
+
+    protected $reader;
+
+    public function __construct(Request $request)
+    {
+        $this->request = $request;
+
+        $this->reader = new Reader(__DIR__.'/../../database/geoip/GeoLite2-City.mmdb');
+    }
+
+    public function handle(Login $event)
+    {
+        $user = $event->user;
+        $ipAddress = $this->request->ip();
+        $userAgent = $this->request->userAgent();
+        $user_id = $user->getAuthIdentifier();
+        $locationService = new LocationService();
+        $location = $locationService->getLocation($ipAddress);
+
+        $agent = new Agent();
+        $agent->setUserAgent($userAgent);
+
+        $browser = $agent->browser();
+        $os = $agent->platform();
+
+        $platform = $agent->isMobile() ? 'Mobile' : 'Desktop';
+
+        $title = $platform.' '.$browser.' on '.$os.' in '.($location['city'] ?? '- Unknown').' - '.($location['country'] ?? null);
+
+        $slug = Str::slug($title);
+
+        $device = UserDevice::updateOrCreate([
+            'user_id' => $user_id,
+            'user_type' => get_class($user),
+            'ip_address' => $ipAddress,
+            'user_agent' => $userAgent,
+        ], [
+            'title' => $title,
+            'slug' => $slug,
+            'active' => true,
+            'os' => $os,
+            'platform' => $platform,
+            'browser' => $browser,
+            'city' => $location['city'] ?? null,
+            'country' => $location['country'] ?? null,
+            'location' => json_encode($location),
+            'whitelisted' => true,
+        ]);
+
+        if ($device->wasRecentlyCreated) {
+            // currently this is an unknown device
+        }
+    }
+}
diff --git a/src/Models/UserDevice.php b/src/Models/UserDevice.php
@@ -11,7 +11,7 @@ class UserDevice extends Model
 
     protected $fillable = [
         'title', 'slug', 'user_id', 'user_type', 'user_agent',
-        'os', 'browser', 'country', 'location', 'whitelisted', 'active', 'ip_address'
+        'platform', 'os', 'browser', 'city', 'country', 'location', 'whitelisted', 'active', 'ip_address',
     ];
 
     /**
@@ -32,7 +32,7 @@ protected static function boot()
      */
     public function user()
     {
-        return $this->morphTo();
+        return $this->belongsTo($this->user_type, 'user_id');
     }
 
     /**
diff --git a/src/Resources/UserDeviceResource.php b/src/Resources/UserDeviceResource.php
@@ -3,14 +3,17 @@
 namespace Moox\UserDevice\Resources;
 
 use Filament\Forms\Components\DateTimePicker;
+use Filament\Forms\Components\Select;
 use Filament\Forms\Components\TextInput;
 use Filament\Forms\Components\Toggle;
 use Filament\Forms\Form;
+use Filament\Forms\Set;
 use Filament\Resources\Resource;
 use Filament\Tables\Actions\DeleteBulkAction;
 use Filament\Tables\Actions\EditAction;
 use Filament\Tables\Columns\TextColumn;
 use Filament\Tables\Table;
+use Illuminate\Support\Facades\Config;
 use Moox\UserDevice\Models\UserDevice;
 use Moox\UserDevice\Resources\UserDeviceResource\Pages\ListPage;
 use Moox\UserDevice\Resources\UserDeviceResource\Widgets\UserDeviceWidgets;
@@ -28,6 +31,30 @@ public static function form(Form $form): Form
                 TextInput::make('title')
                     ->maxLength(255),
                 DateTimePicker::make('created_at'),
+
+                Select::make('user_type')
+                    ->options(function () {
+                        $models = Config::get('user-device.user_models', []);
+
+                        return array_flip($models);
+                    })
+                    ->reactive()
+                    ->afterStateUpdated(function (Set $set, $state) {
+                        $set('user_id', null);
+                    })
+                    ->required(),
+
+                Select::make('user_id')
+                    ->options(function ($get) {
+                        $userType = $get('user_type');
+                        if (! $userType) {
+                            return [];
+                        }
+
+                        return $userType::query()->pluck('name', 'id')->toArray();
+                    })
+                    ->required(),
+
                 Toggle::make('active')
                     ->required(),
             ]);
@@ -47,6 +74,15 @@ public static function table(Table $table): Table
                 TextColumn::make('active')
                     ->label(__('user-device::translations.active'))
                     ->sortable(),
+                TextColumn::make('user_type')
+                    ->label(__('user-device::translations.user_type'))
+                    ->sortable(),
+                TextColumn::make('user_id')
+                    ->label(__('user-device::translations.username'))
+                    ->getStateUsing(function ($record) {
+                        return optional($record->user)->name ?? 'unknown';
+                    })
+                    ->sortable(),
             ])
             ->defaultSort('title', 'desc')
             ->actions([
diff --git a/src/Services/LocationService.php b/src/Services/LocationService.php
@@ -0,0 +1,35 @@
+<?php
+
+namespace Moox\UserDevice\Services;
+
+use GeoIp2\Database\Reader;
+
+class LocationService
+{
+    protected $reader;
+
+    public function __construct()
+    {
+        $mmdbPath = __DIR__.'/../../database/geoip/GeoLite2-City.mmdb';
+        $this->reader = new Reader($mmdbPath);
+    }
+
+    public function getLocation($ipAddress)
+    {
+        try {
+            $record = $this->reader->city($ipAddress);
+
+            return [
+                'city' => $record->city->name,
+                'state' => $record->mostSpecificSubdivision->name,
+                'country' => $record->country->name,
+                'postal' => $record->postal->code,
+                'lat' => $record->location->latitude,
+                'lon' => $record->location->longitude,
+            ];
+        } catch (\Exception $e) {
+            // Handle errors or unknown IPs gracefully
+            return null;
+        }
+    }
+}
diff --git a/src/UserDeviceServiceProvider.php b/src/UserDeviceServiceProvider.php
@@ -4,7 +4,10 @@
 
 namespace Moox\UserDevice;
 
+use Illuminate\Auth\Events\Login;
+use Illuminate\Support\Facades\Event;
 use Moox\UserDevice\Commands\InstallCommand;
+use Moox\UserDevice\Listeners\StoreUserDevice;
 use Spatie\LaravelPackageTools\Package;
 use Spatie\LaravelPackageTools\PackageServiceProvider;
 
@@ -20,4 +23,14 @@ public function configurePackage(Package $package): void
             ->hasMigrations(['create_user_devices_table'])
             ->hasCommand(InstallCommand::class);
     }
+
+    public function boot()
+    {
+        parent::boot();
+
+        Event::listen(
+            Login::class,
+            [StoreUserDevice::class, 'handle']
+        );
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@`
`17`	`17`	`}`
`18`	`18`	`],`
`19`	`19`	`"require": {`
	`20`	`+ "jenssegers/agent": "*",`
`20`	`21`	`"moox/core": "*"`
`21`	`22`	`},`
`22`	`23`	`"autoload": {`