Allow user specific themes (#10799)

* allow user specific themes

* add missing newline

* use global function getDefinitions

* some fixes

* .

* travis fix

* .

* Optimize preference loading
Aka, don't run multiple sql queries per page load, now it is 0-1 queries (for preferences)

* Add a default option for user preferences

* Remove unused code

* more

app/Http/Controllers/UserPreferencesController.php

@@ -28,15 +28,19 @@ namespace App\Http\Controllers;
 use App\Models\Dashboard;
 use App\Models\Device;
 use App\Models\UserPref;
+use Auth;
 use Illuminate\Http\Request;
 use Illuminate\Validation\Rule;
 use LibreNMS\Authentication\LegacyAuth;
 use LibreNMS\Authentication\TwoFactor;
 use LibreNMS\Config;
+use LibreNMS\Util\DynamicConfig;
 use Session;
 
 class UserPreferencesController extends Controller
 {
+    private $cachedPreferences = ['locale', 'site_style'];
+
     public function __construct()
     {
         $this->middleware('deny-demo');
@@ -51,14 +55,25 @@ class UserPreferencesController extends Controller
     public function index(Request $request)
     {
         $user = $request->user();
+
+        $locales = $this->getValidLocales();
+        $styles = $this->getValidStyles();
+        $default_locale = \config('app.locale');
+        $default_style = Config::get('site_style_default', Config::get('site_style'));
+
         $data = [
             'user' => $user,
             'can_change_password' => LegacyAuth::get()->canUpdatePasswords($user->username),
             'dashboards' => Dashboard::allAvailable($user)->with('user')->get(),
             'default_dashboard' => UserPref::getPref($user, 'dashboard'),
             'note_to_device' => UserPref::getPref($user, 'add_schedule_note_to_device'),
-            'locale' => UserPref::getPref($user, 'locale') ?: 'en',
-            'locales' => $this->getValidLocales(),
+            'locale' => UserPref::getPref($user, 'locale'),
+            'locale_default' => $locales[$default_locale] ?? $default_locale,
+            'locales' => $locales,
+            'site_style' => UserPref::getPref($user, 'site_style'),
+            'site_style_default' => $styles[$default_style] ?? $default_style,
+            'site_styles' => $styles,
+
         ];
 
         if (Config::get('twofactor')) {
@@ -89,7 +104,11 @@ class UserPreferencesController extends Controller
             'add_schedule_note_to_device' => 'required|integer',
             'locale' => [
                 'required',
-                Rule::in(array_keys($this->getValidLocales())),
+                Rule::in(array_merge(['default'], array_keys($this->getValidLocales()))),
+            ],
+            'site_style' => [
+                'required',
+                Rule::in(array_merge(['default'], array_keys($this->getValidStyles()))),
             ],
         ];
 
@@ -98,11 +117,7 @@ class UserPreferencesController extends Controller
             'value' => $valid_prefs[$request->pref] ?? 'required|integer',
         ]);
 
-        UserPref::setPref($request->user(), $request->pref, $request->value);
-
-        if ($request->pref == 'locale') {
-            Session::put('locale', $request->value);
-        }
+        $this->updatePreference($request->pref, $request->value);
 
         return response()->json(['status' => 'success']);
     }
@@ -118,4 +133,25 @@ class UserPreferencesController extends Controller
             }
         }, []);
     }
+
+    private function getValidStyles()
+    {
+        $definitions = new DynamicConfig();
+        return $definitions->get('site_style')->getOptions();
+    }
+
+    private function updatePreference($preference, $value)
+    {
+        if ($value == 'default') {
+            UserPref::forgetPref(Auth::user(), $preference);
+            if (in_array($preference, $this->cachedPreferences)) {
+                Session::forget('preferences.' . $preference);
+            }
+        } else {
+            UserPref::setPref(Auth::user(), $preference, $value);
+            if (in_array($preference, $this->cachedPreferences)) {
+                Session::put('preferences.' . $preference, $value);
+            }
+        }
+    }
 }

app/Http/Kernel.php

@@ -34,7 +34,7 @@ class Kernel extends HttpKernel
             \Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
             \Illuminate\Session\Middleware\StartSession::class,
             // \Illuminate\Session\Middleware\AuthenticateSession::class,
-            \App\Http\Middleware\SetLocale::class,
+            \App\Http\Middleware\LoadUserPreferences::class,
             \Illuminate\View\Middleware\ShareErrorsFromSession::class,
             \App\Http\Middleware\VerifyCsrfToken::class,
             \App\Http\Middleware\LegacyExternalAuth::class,

app/Http/Middleware/LoadUserPreferences.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace App\Http\Middleware;
+
+use Auth;
+use Closure;
+use LibreNMS\Config;
+
+class LoadUserPreferences
+{
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        $preferences = ['locale', 'site_style'];
+        $this->loadPreferences($request, $preferences);
+
+        $this->setPreference($request, 'locale', function ($locale) {
+            app()->setLocale($locale);
+        });
+
+        $this->setPreference($request, 'site_style', function ($style) {
+            Config::set('site_style_default', Config::get('site_style'));
+            Config::set('site_style', $style);
+        });
+
+        return $next($request);
+    }
+
+    /**
+     * Fetch preferences from the database
+     * Load all preferences at once if we need to query the database
+     *
+     * @param \Illuminate\Http\Request $request
+     * @param array $preferences
+     */
+    private function loadPreferences($request, $preferences)
+    {
+        if (!$request->session()->has('preferences') && !is_null($request->user())) {
+            $loaded = $request->user()->preferences()->whereIn('pref', $preferences)->pluck('value', 'pref');
+            $request->session()->put('preferences', $loaded);
+        }
+    }
+
+    /**
+     * @param \Illuminate\Http\Request $request
+     * @param string $pref
+     * @param callable $callable
+     */
+    private function setPreference($request, $pref, $callable)
+    {
+        $value = $request->session()->get("preferences.$pref");
+        if ($value !== null) {
+            $callable($value);
+        }
+    }
+}

app/Http/Middleware/SetLocale.php

@@ -1,34 +0,0 @@
-<?php
-
-namespace App\Http\Middleware;
-
-use App;
-use App\Models\UserPref;
-use Closure;
-use Session;
-
-class SetLocale
-{
-    /**
-     * Handle an incoming request.
-     *
-     * @param  \Illuminate\Http\Request  $request
-     * @param  \Closure  $next
-     * @return mixed
-     */
-    public function handle($request, Closure $next)
-    {
-        if (Session::has('locale')) {
-            $locale = Session::get('locale');
-        } elseif (!is_null($request->user())) {
-            $locale = UserPref::getPref($request->user(), 'locale');
-            Session::put('locale', $locale);
-        }
-
-        if (!empty($locale)) {
-            App::setLocale($locale);
-        }
-
-        return $next($request);
-    }
-}

app/Http/ViewComposers/MenuComposer.php

@@ -33,6 +33,7 @@ use App\Models\Location;
 use App\Models\Notification;
 use App\Models\Package;
 use App\Models\User;
+use App\Models\UserPref;
 use App\Models\Vminfo;
 use App\Models\WirelessSensor;
 use Auth;
@@ -53,11 +54,12 @@ class MenuComposer
         $vars = [];
         /** @var User $user */
         $user = Auth::user();
+        $site_style = Config::get('site_style');
 
-        $vars['navbar'] = in_array(Config::get('site_style'), ['mono', 'dark']) ? 'navbar-inverse' : '';
+        //TODO: should be handled via CSS Themes
+        $vars['navbar'] = in_array($site_style, ['mono', 'dark']) ? 'navbar-inverse' : '';
 
         $vars['project_name'] = Config::get('project_name', 'LibreNMS');
-        $site_style = Config::get('site_style', 'light');
         $vars['title_image'] = Config::get('title_image', "images/librenms_logo_$site_style.svg");
 
         // Device menu