feat: (LAR-86) add bannished sysem (#218)

bannish user
unbannished user
bannished user can not login
send mail when ban or unban user

Author: StevyMarlino

app/Actions/User/BanUserAction.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions\User;
+
+use App\Events\UserBannedEvent;
+use App\Exceptions\CannotBanAdminException;
+use App\Exceptions\UserAlreadyBannedException;
+use App\Models\User;
+
+final class BanUserAction
+{
+    public function execute(User $user, string $reason): void
+    {
+        if ($user->isAdmin() || $user->isModerator()) {
+            throw new CannotBanAdminException('Impossible de bannir un administrateur.');
+        }
+
+        if ($user->isBanned()) {
+            throw new UserAlreadyBannedException('Impossible de bannir cet utilisateur car il est déjà banni.');
+        }
+
+        $user->update([
+            'banned_at' => now(),
+            'banned_reason' => $reason,
+        ]);
+
+        event(new UserBannedEvent($user));
+    }
+}

app/Actions/User/UnBanUserAction.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Actions\User;
+
+use App\Events\UserUnbannedEvent;
+use App\Models\User;
+
+final class UnBanUserAction
+{
+    public function execute(User $user): void
+    {
+        $user->update([
+            'banned_at' => null,
+            'banned_reason' => null,
+        ]);
+
+        event(new UserUnbannedEvent($user));
+    }
+}

app/Events/UserBannedEvent.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Events;
+
+use App\Models\User;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+final class UserBannedEvent
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    public function __construct(public User $user) {}
+}

app/Events/UserUnbannedEvent.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Events;
+
+use App\Models\User;
+use Illuminate\Broadcasting\InteractsWithSockets;
+use Illuminate\Foundation\Events\Dispatchable;
+use Illuminate\Queue\SerializesModels;
+
+final class UserUnbannedEvent
+{
+    use Dispatchable, InteractsWithSockets, SerializesModels;
+
+    public function __construct(public User $user) {}
+}

app/Exceptions/CannotBanAdminException.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exceptions;
+
+use Exception;
+
+/**
+ * @property string $message
+ */
+final class CannotBanAdminException extends Exception {}

app/Exceptions/UserAlreadyBannedException.php

@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Exceptions;
+
+use Exception;
+
+/**
+ * @property string $message
+ */
+final class UserAlreadyBannedException extends Exception {}

app/Filament/Resources/UserResource.php

@@ -4,10 +4,14 @@
 
 namespace App\Filament\Resources;
 
+use App\Actions\User\BanUserAction;
+use App\Actions\User\UnBanUserAction;
 use App\Filament\Resources\UserResource\Pages;
 use App\Models\User;
 use Awcodes\FilamentBadgeableColumn\Components\Badge;
 use Awcodes\FilamentBadgeableColumn\Components\BadgeableColumn;
+use Filament\Forms\Components\TextInput;
+use Filament\Notifications\Notification;
 use Filament\Resources\Resource;
 use Filament\Tables;
 use Filament\Tables\Table;
@@ -51,21 +55,63 @@ public static function table(Table $table): Table
                     ->icon('untitledui-inbox')
                     ->description(fn ($record): ?string => $record->phone_number),
                 Tables\Columns\TextColumn::make('email_verified_at')
-                    ->label('Validation Email')
+                    ->label(__('user.validate_email'))
                     ->placeholder('N/A')
                     ->date(),
                 Tables\Columns\TextColumn::make(name: 'created_at')
-                    ->label('Inscription')
+                    ->label(__('use.inscription'))
                     ->date(),
             ])
             ->filters([
                 Tables\Filters\TernaryFilter::make('email_verified_at')
-                    ->label('Email Vérifiée')
+                    ->label(__('user.email_verified'))
                     ->nullable(),
             ])
             ->actions([
-                Tables\Actions\DeleteAction::make()
-                    ->iconButton(),
+                Tables\Actions\Action::make('ban')
+                    ->label(__('actions.ban'))
+                    ->icon('untitledui-archive')
+                    ->color('warning')
+                    ->visible(fn ($record) => $record->banned_at == null)
+                    ->modalHeading(__('user.ban.heading'))
+                    ->modalDescription(__('user.ban.description'))
+                    ->authorize('ban', User::class)
+                    ->form([
+                        TextInput::make('banned_reason')
+                            ->label(__('user.ban.reason'))
+                            ->required(),
+                    ])
+                    ->action(function (User $record, array $data): void {
+                        app(BanUserAction::class)->execute($record, $data['banned_reason']);
+
+                        Notification::make()
+                            ->success()
+                            ->duration(5000)
+                            ->title(__('notifications.user.banned_title'))
+                            ->body(__('notifications.user.banned_body'))
+                            ->send();
+                    })
+                    ->requiresConfirmation(),
+
+                Tables\Actions\Action::make('unban')
+                    ->label(__('actions.unban'))
+                    ->icon('heroicon-o-check-circle')
+                    ->color('success')
+                    ->visible(fn ($record) => $record->banned_at !== null)
+                    ->authorize('unban', User::class)
+                    ->action(function (User $record): void {
+                        app(UnBanUserAction::class)->execute($record);
+
+                        Notification::make()
+                            ->success()
+                            ->title(__('notifications.user.unbanned_title'))
+                            ->duration(5000)
+                            ->body(__('notifications.user.unbanned_body'))
+                            ->send();
+                    })
+                    ->requiresConfirmation(),
+
+                Tables\Actions\DeleteAction::make(),
             ])
             ->bulkActions([
                 Tables\Actions\DeleteBulkAction::make(),

app/Filament/Resources/UserResource/Pages/ListUsers.php

@@ -5,9 +5,21 @@
 namespace App\Filament\Resources\UserResource\Pages;
 
 use App\Filament\Resources\UserResource;
+use Filament\Resources\Components\Tab;
 use Filament\Resources\Pages\ListRecords;
 
 final class ListUsers extends ListRecords
 {
     protected static string $resource = UserResource::class;
+
+    public function getTabs(): array
+    {
+        return [
+            'all' => Tab::make(__('global.all')),
+            'banned' => Tab::make(__('global.banned'))
+                ->modifyQueryUsing(fn ($query) => $query->isBanned()),
+            'unbanned' => Tab::make(__('global.unbanned'))
+                ->modifyQueryUsing(fn ($query) => $query->isNotBanned()),
+        ];
+    }
 }

app/Http/Middleware/CheckIfBanned.php

@@ -0,0 +1,27 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Http\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Illuminate\Support\Facades\Auth;
+use Symfony\Component\HttpFoundation\Response;
+
+final class CheckIfBanned
+{
+    public function handle(Request $request, Closure $next): Response
+    {
+        // @phpstan-ignore-next-line
+        if (Auth::check() && Auth::user()->isBanned()) {
+            Auth::logout();
+
+            return redirect()->route('login')->withErrors([
+                'email' => __('user.ban.message'),
+            ]);
+        }
+
+        return $next($request);
+    }
+}

app/Jobs/SendBanEmailJob.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\Models\User;
+use App\Notifications\UserBannedNotification;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+final class SendBanEmailJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function __construct(public User $user) {}
+
+    public function handle(): void
+    {
+        $this->user->notify(new UserBannedNotification($this->user));
+    }
+}

app/Jobs/SendUnbanEmailJob.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Jobs;
+
+use App\Models\User;
+use App\Notifications\UserUnBannedNotification;
+use Illuminate\Bus\Queueable;
+use Illuminate\Contracts\Queue\ShouldQueue;
+use Illuminate\Foundation\Bus\Dispatchable;
+use Illuminate\Queue\InteractsWithQueue;
+use Illuminate\Queue\SerializesModels;
+
+final class SendUnbanEmailJob implements ShouldQueue
+{
+    use Dispatchable, InteractsWithQueue, Queueable, SerializesModels;
+
+    public function __construct(public User $user) {}
+
+    public function handle(): void
+    {
+        $this->user->notify(new UserUnBannedNotification($this->user));
+    }
+}

app/Listeners/SendBanNotificationListener.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Listeners;
+
+use App\Events\UserBannedEvent;
+use App\Jobs\SendBanEmailJob;
+
+final class SendBanNotificationListener
+{
+    /**
+     * Handle the event.
+     */
+    public function handle(UserBannedEvent $event): void
+    {
+        SendBanEmailJob::dispatch($event->user);
+    }
+}

app/Listeners/SendUnbanNotificationListener.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Listeners;
+
+use App\Events\UserUnbannedEvent;
+use App\Jobs\SendUnbanEmailJob;
+
+final class SendUnbanNotificationListener
+{
+    /**
+     * Handle the event.
+     */
+    public function handle(UserUnbannedEvent $event): void
+    {
+        SendUnbanEmailJob::dispatch($event->user);
+    }
+}

app/Mail/UserBannedEMail.php

@@ -0,0 +1,33 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Mail;
+
+use App\Models\User;
+use Illuminate\Bus\Queueable;
+use Illuminate\Mail\Mailable;
+use Illuminate\Mail\Mailables\Content;
+use Illuminate\Mail\Mailables\Envelope;
+use Illuminate\Queue\SerializesModels;
+
+final class UserBannedEMail extends Mailable
+{
+    use Queueable, SerializesModels;
+
+    public function __construct(public User $user) {}
+
+    public function envelope(): Envelope
+    {
+        return new Envelope(
+            subject: __('user.ban.email_subject'),
+        );
+    }
+
+    public function content(): Content
+    {
+        return new Content(
+            markdown: 'emails.send-banned-message',
+        );
+    }
+}