#863 Impersonation

app/Audit.php

@@ -2,6 +2,7 @@
 
 namespace App;
 
+use App\Enums\SessionVariables;
 use Auth;
 use Illuminate\Database\Eloquent\Model;
 
@@ -17,10 +18,21 @@ public function getTimeDateAttribute() {
     }
 
     public static function newAudit(string $message): void {
+        $impersonated_by_id = null;
+        $impersonation_string = '';
+        if (session()->has(SessionVariables::IMPERSONATING_USER->value)) {
+            $impersonated_by_id = session(SessionVariables::IMPERSONATING_USER->value);
+            $impersonation_user = User::find($impersonated_by_id);
+
+            $impersonation_string = 'IMPERSONATED BY ' . (is_null($impersonation_user) ? 'UNKNOWN' : $impersonation_user->full_name) . ': ';
+        }
+        $impersonated_by_id = session()->has(SessionVariables::IMPERSONATING_USER->value) ? session(SessionVariables::IMPERSONATING_USER->value) : null;
+
         $audit = new Audit;
         $audit->cid = Auth::id();
+        $audit->impersonated_by_id = $impersonated_by_id;
         $audit->ip = $_SERVER['REMOTE_ADDR'];
-        $audit->what = Auth::user()->full_name . ' ' . $message;
+        $audit->what = $impersonation_string . Auth::user()->full_name . ' ' . $message;
         $audit->save();
     }
 }

app/Enums/FeatureToggles.php

@@ -10,4 +10,5 @@ enum FeatureToggles: string {
     case CUSTOM_THEME_LOGO = 'custom_theme_logo';
     case LOCAL_HERO = 'local-hero';
     case AUTO_SUPPORT_EVENTS = 'auto_support_events';
+    case IMPERSONATION = 'impersonation';
 }

app/Enums/SessionVariables.php

@@ -4,8 +4,11 @@
 
 enum SessionVariables: string {
     case SUCCESS = 'success';
+    case WARNING = 'warning';
     case ERROR = 'error';
     case VATSIM_AUTH_STATE = 'vatsimauthstate';
     case REALOPS_PILOT_REDIRECT = 'pilot_redirect';
     case REALOPS_PILOT_REDIRECT_PATH = 'pilot_redirect_path';
+    case IMPERSONATE = 'impersonate';
+    case IMPERSONATING_USER = 'impersonating_user';
 }

app/Http/Controllers/ImpersonationController.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\Http\Controllers;
+
+use App\Audit;
+use App\Enums\SessionVariables;
+use App\User;
+use Illuminate\Http\Request;
+
+class ImpersonationController extends Controller {
+    public function start(Request $request) {
+        $user = User::find($request->user_id);
+        $is_impersonating = session()->has(SessionVariables::IMPERSONATE->value);
+        if (is_null($user)) {
+            return redirect()->back()->with(SessionVariables::ERROR->value, 'That user does not exist');
+        }
+
+        if ($is_impersonating) {
+            return redirect()->back()->with(SessionVariables::ERROR->value, 'You must first stop impersonating your current user before beginning a new session');
+        }
+
+        session()->put(SessionVariables::IMPERSONATE->value, $user->id);
+        Audit::newAudit('started impersonating user ' . $user->impersonation_name . '.');
+
+        return redirect('/dashboard');
+    }
+
+    public function stop() {
+        Audit::newAudit('impersonation session ending...');
+
+        session()->forget(SessionVariables::IMPERSONATE->value);
+        return redirect('/dashboard');
+    }
+}

app/Http/Kernel.php

@@ -35,6 +35,7 @@ class Kernel extends HttpKernel {
             \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
             \App\Http\Middleware\VerifyCsrfToken::class,
             \Illuminate\Routing\Middleware\SubstituteBindings::class,
+            \App\Http\Middleware\Impersonation::class,
         ],
 
         'api' => [

app/Http/Middleware/Impersonation.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use App\Enums\FeatureToggles;
+use App\Enums\SessionVariables;
+use Auth;
+use Closure;
+use Illuminate\Http\Request;
+use Symfony\Component\HttpFoundation\Response;
+
+class Impersonation {
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Closure(\Illuminate\Http\Request): (\Symfony\Component\HttpFoundation\Response)  $next
+     */
+    public function handle(Request $request, Closure $next): Response {
+        if (toggleEnabled(FeatureToggles::IMPERSONATION) && session()->has(SessionVariables::IMPERSONATE->value) && Auth::check() && (Auth::user()->hasRole('wm') || Auth::user()->hasRole('awm'))) {
+            session()->put(SessionVariables::IMPERSONATING_USER->value, Auth::id());
+            Auth::onceUsingId(session(SessionVariables::IMPERSONATE->value));
+        }
+
+        return $next($request);
+    }
+}

app/Providers/AppServiceProvider.php

@@ -4,6 +4,7 @@
 
 use App\Enums\FeatureToggles;
 use App\Enums\SessionVariables;
+use App\View\Composers\ImpersonationComposer;
 use Illuminate\Pagination\LengthAwarePaginator;
 use Illuminate\Pagination\Paginator;
 use Illuminate\Support\Collection;
@@ -29,6 +30,7 @@ public function boot(): void {
 
         View::share('FeatureToggles', FeatureToggles::class);
         View::share('SessionVariables', SessionVariables::class);
+        View::composer(['inc.dashboard_head', 'inc.impersonation_warning'], ImpersonationComposer::class);
 
         /**
          * Paginate a standard Laravel Collection.

app/User.php

@@ -73,6 +73,22 @@ public function getFullNameRatingAttribute() {
         return $this->full_name . ' - ' . $this->rating_short;
     }
 
+    public function getImpersonationNameAttribute() {
+        $roles = array_reduce($this->roles->toArray(), function ($role_string, $role) {
+            return $role_string . $role['name'] . ', ';
+        }, '');
+
+        if ($this->visitor) {
+            $roles = 'visitor';
+        }
+
+        if ($roles != '') {
+            $roles = ' (' . trim($roles, ', ') . ')';
+        }
+
+        return $this->backwards_name . ' ' . $this->id . ' - ' . $this->rating_short . $roles;
+    }
+
     public static $RatingShort = [
         0 => 'N/A',
         1 => 'OBS', 2 => 'S1',

app/View/Composers/ImpersonationComposer.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace App\View\Composers;
+
+use App\Enums\FeatureToggles;
+use App\Enums\SessionVariables;
+use App\User;
+use Auth;
+use Illuminate\View\View;
+
+class ImpersonationComposer {
+    /**
+     * Create a new profile composer.
+     */
+    public function __construct(
+    ) {
+    }
+
+    /**
+     * Bind data to the view.
+     */
+    public function compose(View $view): void {
+        if (toggleEnabled(FeatureToggles::IMPERSONATION)) {
+            $users = null;
+            $is_impersonating = session()->has(SessionVariables::IMPERSONATE->value);
+
+            if (Auth::user()->hasRole('wm') || Auth::user()->hasRole('awm')) {
+                $users = User::where('status', 1)->orderBy('lname', 'ASC')->get()->pluck('impersonation_name', 'id');
+            }
+
+            $view->with('users', $users)->with('is_impersonating', $is_impersonating);
+        }
+    }
+}

database/migrations/2026_02_23_141539_update_audits_add_impersonated_by_id_column.php

@@ -0,0 +1,27 @@
+<?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('audits', function (Blueprint $table) {
+            $table->integer('impersonated_by_id')->nullable();
+
+            $table->foreign('impersonated_by_id')->references('id')->on('roster')->nullOnDelete();
+        });
+    }
+
+    /**
+     * Reverse the migrations.
+     */
+    public function down(): void {
+        Schema::table('audits', function (Blueprint $table) {
+            $table->dropColumn('impersonated_by_id');
+        });
+    }
+};

resources/views/inc/dashboard_head.blade.php

@@ -1,25 +1,26 @@
-    <nav class="navbar navbar-expand-lg navbar-light">
-        <div class="container-fluid">
+<nav class="navbar navbar-expand-lg navbar-light">
+    <div class="container-fluid">
         <a class="navbar-brand" href="/dashboard">
             @include('inc.logo', ['color' => 'black'])
         </a>
-        <div class="d-flex justify-content-start ms-5 collapse navbar-collapse">
-
-                {{ html()->form()->route('searchAirport')->class(['row','row-cols-lg-auto'])->open() }}
-                    <div class="col-12 input-group">
-                        {{ html()->text('apt', null)->placeholder('Search Airport ICAO')->class(['form-control']) }}
-                        &nbsp;
-                        <button class="btn btn-success" type="submit">Search</button>
-                    </div>
+        <ul class="navbar-nav me-auto align-items-center">
+            {{ html()->form()->route('searchAirport')->class(['form-inline'])->open() }}
+                <div class="col-12 input-group">
+                    {{ html()->text('apt', null)->placeholder('Search Airport ICAO')->class(['form-control']) }}
+                    &nbsp;
+                    <button class="btn btn-success" type="submit">Search</button>
+                </div>
+            {{ html()->form()->close() }}
+        </ul>
+        <ul class="navbar-nav ml-auto align-items-center">
+            <a class="nav-link {{ Nav::isRoute('controller_dash_home') }}" href="/dashboard">Dashboard Home</a>
+            @if(toggleEnabled($FeatureToggles::IMPERSONATION) && (Auth::user()->hasRole('wm') || Auth::user()->hasRole('awm')))
+                {{ html()->form()->route('startImpersonation')->class(['form-inline'])->open() }}
+                    {{ html()->select('user_id', $users, Auth::id())->class(['form-select'])->attributes(['onchange' => 'this.form.submit()'])->disabled($is_impersonating) }}
                 {{ html()->form()->close() }}
-</div>
-
-            <ul class="navbar-nav ms-auto">
-			<a class="nav-link {{ Nav::isRoute('controller_dash_home') }}" href="/dashboard">Dashboard Home</a>
-                <li class="nav-item dropdown">
-                    <a class="nav-link" style="pointer-events:none">{{ Auth::user()->full_name }} - {{ Auth::user()->rating_short }}</a>
-                </li>
-            </ul>
-        </div>
-</div>
-    </nav>
+            @else
+                <a class="nav-link disabled">{{ Auth::user()->full_name }} - {{ Auth::user()->rating_short }}</a>
+            @endif
+        </ul>
+    </div>
+</nav>

resources/views/inc/impersonation_warning.blade.php

@@ -0,0 +1,6 @@
+@if(isset($is_impersonating) && $is_impersonating && toggleEnabled($FeatureToggles::IMPERSONATION))
+    <br>
+    <a class="d-block alert alert-warning" href="/dashboard/admin/impersonation/stop">
+        WARNING: You are currently impersonating a user. Use extreme caution as any action you perform will be performed as that user, and will be tracked as so with you as the impersonator. This should be used for debugging and development only! Click this warning at any time to end impersonation.
+    </a>
+@endif

resources/views/inc/messages.blade.php

@@ -16,6 +16,13 @@
     </div>
 @endif
 
+@if(session()->has($SessionVariables::WARNING->value))
+    <br>
+    <div class="alert alert-warning">
+        {{ session($SessionVariables::WARNING->value) }}
+    </div>
+@endif
+
 @if(session()->has($SessionVariables::ERROR->value))
     <br>
     <div class="alert alert-danger">

resources/views/layouts/dashboard.blade.php

@@ -31,6 +31,11 @@
         </title>
     </head>
     <body>
+        {{-- Impersonation Warning --}}
+        <div class="container">
+            @include('inc.impersonation_warning')
+        </div>
+
         {{-- Messages --}}
         <div class="container">
             @include('inc.messages')

resources/views/layouts/master.blade.php

@@ -34,6 +34,10 @@
         </title>
     </head>
     <body>
+        {{-- Impersonation Warning --}}
+        <div class="container">
+            @include('inc.impersonation_warning')
+        </div>
 
         {{-- Messages --}}
         <div class="container-fluid bg-secondary">

routes/web.php

@@ -333,6 +333,11 @@
         Route::prefix('monitor')->middleware('permission:staff')->group(function () {
             Route::get('/', 'AdminDash@backgroundMonitor');
         });
+
+        Route::prefix('impersonation')->middleware('toggle:impersonation')->group(function () {
+            Route::post('/', 'ImpersonationController@start')->middleware('role:wm|awm')->name('startImpersonation');
+            Route::get('/stop', 'ImpersonationController@stop')->name('stopImpersonation');
+        });
     });
 });
 /*