librenms / librenms

app/Http/Controllers/UserPreferencesController.php

<?php
/**
 * UserPreferencesController.php
 *
 * -Description-
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 * @link       https://www.librenms.org
 *
 * @copyright  2019 Tony Murray
 * @author     Tony Murray <murraytony@gmail.com>
 */

namespace App\Http\Controllers;

use App\Models\Dashboard;
use App\Models\Device;
use App\Models\UserPref;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Auth;
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');
    }

    /**
     * Display a listing of the resource.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\View\View
     */
    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');

        $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'),
            '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,
            'hide_dashboard_editor' => UserPref::getPref($user, 'hide_dashboard_editor') ?? 0,
        ];

        if (Config::get('twofactor')) {
            $twofactor = UserPref::getPref($user, 'twofactor');
            if ($twofactor) {
                $data['twofactor_uri'] = TwoFactor::generateUri($user->username, $twofactor['key'], $twofactor['counter'] !== false);
            }
            $data['twofactor'] = $twofactor;
        }

        if (! $user->hasGlobalRead()) {
            $data['devices'] = Device::hasAccess($user)->get();
        }

        return view('user.preferences', $data);
    }

    /**
     * Store a newly created resource in storage.
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\JsonResponse
     */
    public function store(Request $request)
    {
        $valid_prefs = [
            'dashboard' => 'required|integer',
            'add_schedule_note_to_device' => 'required|integer',
            'locale' => [
                'required',
                Rule::in(array_merge(['default'], array_keys($this->getValidLocales()))),
            ],
            'site_style' => [
                'required',
                Rule::in(array_merge(['default'], array_keys($this->getValidStyles()))),
            ],
            'hide_dashboard_editor' => 'required|integer',
        ];

        $this->validate($request, [
            'pref' => ['required', Rule::in(array_keys($valid_prefs))],
            'value' => $valid_prefs[$request->pref] ?? 'required|integer',
        ]);

        $this->updatePreference($request->pref, $request->value);

        return response()->json(['status' => 'success']);
    }

    private function getValidLocales()
    {
        return array_reduce(glob(resource_path('lang') . '/*', GLOB_ONLYDIR), function ($locales, $locale) {
            $locale = basename($locale);
            $lang = __('preferences.lang', [], $locale);
            $locales[$locale] = ($lang == 'preferences.lang' ? $locale : $lang);

            return $locales;
        }, []);
    }

    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);

It seems like Illuminate\Support\Facades\Auth::user() can also be of type null; however, parameter $user of App\Models\UserPref::forgetPref() does only seem to accept App\Models\User, maybe add an additional type check?

            if (in_array($preference, $this->cachedPreferences)) {
                Session::forget('preferences.' . $preference);
            }
        } else {
            UserPref::setPref(Auth::user(), $preference, $value);

It seems like Illuminate\Support\Facades\Auth::user() can also be of type null; however, parameter $user of App\Models\UserPref::setPref() does only seem to accept App\Models\User, maybe add an additional type check?

            if (in_array($preference, $this->cachedPreferences)) {
                Session::put('preferences.' . $preference, $value);
            }
        }
    }
}