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('shortcuts', []);
  39         $shortcuts = new UserShortcutMap($providedShortcuts);
  40
  41         setting()->putUser(user(), 'ui-shortcuts', $shortcuts->toJson());
  42         setting()->putUser(user(), 'ui-shortcuts-enabled', $enabled);
  43
  44         $this->showSuccessNotification('Shortcuts preferences have been updated!');
  45
  46         return redirect('/preferences/shortcuts');
  47     }
  48
  49     /**
  50      * Update the user's preferred book-list display setting.
  51      */
  52     public function switchBooksView(Request $request, int $id)
  53     {
  54         return $this->switchViewType($id, $request, 'books');
  55     }
  56
  57     /**
  58      * Update the user's preferred shelf-list display setting.
  59      */
  60     public function switchShelvesView(Request $request, int $id)
  61     {
  62         return $this->switchViewType($id, $request, 'bookshelves');
  63     }
  64
  65     /**
  66      * Update the user's preferred shelf-view book list display setting.
  67      */
  68     public function switchShelfView(Request $request, int $id)
  69     {
  70         return $this->switchViewType($id, $request, 'bookshelf');
  71     }
  72
  73     /**
  74      * For a type of list, switch with stored view type for a user.
  75      */
  76     protected function switchViewType(int $userId, Request $request, string $listName)
  77     {
  78         $this->checkPermissionOrCurrentUser('users-manage', $userId);
  79
  80         $viewType = $request->get('view_type');
  81         if (!in_array($viewType, ['grid', 'list'])) {
  82             $viewType = 'list';
  83         }
  84
  85         $user = $this->userRepo->getById($userId);
  86         $key = $listName . '_view_type';
  87         setting()->putUser($user, $key, $viewType);
  88
  89         return redirect()->back(302, [], "/settings/users/$userId");
  90     }
  91
  92     /**
  93      * Change the stored sort type for a particular view.
  94      */
  95     public function changeSort(Request $request, string $id, string $type)
  96     {
  97         $validSortTypes = ['books', 'bookshelves', 'shelf_books', 'users', 'roles', 'webhooks', 'tags', 'page_revisions'];
  98         if (!in_array($type, $validSortTypes)) {
  99             return redirect()->back(500);
 100         }
 101
 102         $this->checkPermissionOrCurrentUser('users-manage', $id);
 103
 104         $sort = substr($request->get('sort') ?: 'name', 0, 50);
 105         $order = $request->get('order') === 'desc' ? 'desc' : 'asc';
 106
 107         $user = $this->userRepo->getById($id);
 108         $sortKey = $type . '_sort';
 109         $orderKey = $type . '_sort_order';
 110         setting()->putUser($user, $sortKey, $sort);
 111         setting()->putUser($user, $orderKey, $order);
 112
 113         return redirect()->back(302, [], "/settings/users/{$id}");
 114     }
 115
 116     /**
 117      * Toggle dark mode for the current user.
 118      */
 119     public function toggleDarkMode()
 120     {
 121         $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
 122         setting()->putUser(user(), 'dark-mode-enabled', $enabled ? 'false' : 'true');
 123
 124         return redirect()->back();
 125     }
 126
 127     /**
 128      * Update the stored section expansion preference for the given user.
 129      */
 130     public function updateExpansionPreference(Request $request, string $id, string $key)
 131     {
 132         $this->checkPermissionOrCurrentUser('users-manage', $id);
 133         $keyWhitelist = ['home-details'];
 134         if (!in_array($key, $keyWhitelist)) {
 135             return response('Invalid key', 500);
 136         }
 137
 138         $newState = $request->get('expand', 'false');
 139
 140         $user = $this->userRepo->getById($id);
 141         setting()->putUser($user, 'section_expansion#' . $key, $newState);
 142
 143         return response('', 204);
 144     }
 145
 146     public function updateCodeLanguageFavourite(Request $request)
 147     {
 148         $validated = $this->validate($request, [
 149             'language' => ['required', 'string', 'max:20'],
 150             'active'   => ['required', 'bool'],
 151         ]);
 152
 153         $currentFavoritesStr = setting()->getForCurrentUser('code-language-favourites', '');
 154         $currentFavorites = array_filter(explode(',', $currentFavoritesStr));
 155
 156         $isFav = in_array($validated['language'], $currentFavorites);
 157         if (!$isFav && $validated['active']) {
 158             $currentFavorites[] = $validated['language'];
 159         } elseif ($isFav && !$validated['active']) {
 160             $index = array_search($validated['language'], $currentFavorites);
 161             array_splice($currentFavorites, $index, 1);
 162         }
 163
 164         setting()->putUser(user(), 'code-language-favourites', implode(',', $currentFavorites));
 165     }
 166 }