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

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