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

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