BookStack Code Mirror - bookstack/blob - app/Http/Controllers/UserPreferencesController.php

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Auth\UserRepo;
   6 use BookStack\Settings\UserShortcutMap;
   7 use Illuminate\Http\Request;
   8
   9 class UserPreferencesController extends Controller
  10 {
  11     protected UserRepo $userRepo;
  12
  13     public function __construct(UserRepo $userRepo)
  14     {
  15         $this->userRepo = $userRepo;
  16     }
  17
  18     /**
  19      * Show the user-specific interface shortcuts.
  20      */
  21     public function showShortcuts()
  22     {
  23         $shortcuts = UserShortcutMap::fromUserPreferences();
  24         $enabled = setting()->getForCurrentUser('ui-shortcuts-enabled', false);
  25
  26         return view('users.preferences.shortcuts', [
  27             'shortcuts' => $shortcuts,
  28             'enabled' => $enabled,
  29         ]);
  30     }
  31
  32     /**
  33      * Update the user-specific interface shortcuts.
  34      */
  35     public function updateShortcuts(Request $request)
  36     {
  37         $enabled = $request->get('enabled') === 'true';
  38         $providedShortcuts = $request->get('shortcut', []);
  39         $shortcuts = new UserShortcutMap($providedShortcuts);
  40
  41         setting()->putForCurrentUser('ui-shortcuts', $shortcuts->toJson());
  42         setting()->putForCurrentUser('ui-shortcuts-enabled', $enabled);
  43
  44         $this->showSuccessNotification(trans('preferences.shortcuts_update_success'));
  45
  46         return redirect('/preferences/shortcuts');
  47     }
  48
  49     /**
  50      * Update the preferred view format for a list view of the given type.
  51      */
  52     public function changeView(Request $request, string $type)
  53     {
  54         $valueViewTypes = ['books', 'bookshelves', 'bookshelf'];
  55         if (!in_array($type, $valueViewTypes)) {
  56             return redirect()->back(500);
  57         }
  58
  59         $view = $request->get('view');
  60         if (!in_array($view, ['grid', 'list'])) {
  61             $view = 'list';
  62         }
  63
  64         $key = $type . '_view_type';
  65         setting()->putForCurrentUser($key, $view);
  66
  67         return redirect()->back(302, [], "/");
  68     }
  69
  70     /**
  71      * Change the stored sort type for a particular view.
  72      */
  73     public function changeSort(Request $request, string $type)
  74     {
  75         $validSortTypes = ['books', 'bookshelves', 'shelf_books', 'users', 'roles', 'webhooks', 'tags', 'page_revisions'];
  76         if (!in_array($type, $validSortTypes)) {
  77             return redirect()->back(500);
  78         }
  79
  80         $sort = substr($request->get('sort') ?: 'name', 0, 50);
  81         $order = $request->get('order') === 'desc' ? 'desc' : 'asc';
  82
  83         $sortKey = $type . '_sort';
  84         $orderKey = $type . '_sort_order';
  85         setting()->putForCurrentUser($sortKey, $sort);
  86         setting()->putForCurrentUser($orderKey, $order);
  87
  88         return redirect()->back(302, [], "/");
  89     }
  90
  91     /**
  92      * Toggle dark mode for the current user.
  93      */
  94     public function toggleDarkMode()
  95     {
  96         $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
  97         setting()->putForCurrentUser('dark-mode-enabled', $enabled ? 'false' : 'true');
  98
  99         return redirect()->back();
 100     }
 101
 102     /**
 103      * Update the stored section expansion preference for the given user.
 104      */
 105     public function changeExpansion(Request $request, string $type)
 106     {
 107         $typeWhitelist = ['home-details'];
 108         if (!in_array($type, $typeWhitelist)) {
 109             return response('Invalid key', 500);
 110         }
 111
 112         $newState = $request->get('expand', 'false');
 113         setting()->putForCurrentUser('section_expansion#' . $type, $newState);
 114
 115         return response('', 204);
 116     }
 117
 118     public function updateCodeLanguageFavourite(Request $request)
 119     {
 120         $validated = $this->validate($request, [
 121             'language' => ['required', 'string', 'max:20'],
 122             'active'   => ['required', 'bool'],
 123         ]);
 124
 125         $currentFavoritesStr = setting()->getForCurrentUser('code-language-favourites', '');
 126         $currentFavorites = array_filter(explode(',', $currentFavoritesStr));
 127
 128         $isFav = in_array($validated['language'], $currentFavorites);
 129         if (!$isFav && $validated['active']) {
 130             $currentFavorites[] = $validated['language'];
 131         } elseif ($isFav && !$validated['active']) {
 132             $index = array_search($validated['language'], $currentFavorites);
 133             array_splice($currentFavorites, $index, 1);
 134         }
 135
 136         setting()->putForCurrentUser('code-language-favourites', implode(',', $currentFavorites));
 137     }
 138 }