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         $this->preventGuestAccess();
  66
  67         $preferences = (new UserNotificationPreferences(user()));
  68
  69         $query = Watch::query()->where('user_id', '=', user()->id);
  70         $query = $permissions->restrictEntityRelationQuery($query, 'watches', 'watchable_id', 'watchable_type');
  71         $watches = $query->with('watchable')->paginate(20);
  72
  73         return view('users.preferences.notifications', [
  74             'preferences' => $preferences,
  75             'watches' => $watches,
  76         ]);
  77     }
  78
  79     /**
  80      * Update the notification preferences for the current user.
  81      */
  82     public function updateNotifications(Request $request)
  83     {
  84         $this->checkPermission('receive-notifications');
  85         $this->preventGuestAccess();
  86         $data = $this->validate($request, [
  87            'preferences' => ['required', 'array'],
  88            'preferences.*' => ['required', 'string'],
  89         ]);
  90
  91         $preferences = (new UserNotificationPreferences(user()));
  92         $preferences->updateFromSettingsArray($data['preferences']);
  93         $this->showSuccessNotification(trans('preferences.notifications_update_success'));
  94
  95         return redirect('/preferences/notifications');
  96     }
  97
  98     /**
  99      * Update the preferred view format for a list view of the given type.
 100      */
 101     public function changeView(Request $request, string $type)
 102     {
 103         $valueViewTypes = ['books', 'bookshelves', 'bookshelf'];
 104         if (!in_array($type, $valueViewTypes)) {
 105             return redirect()->back(500);
 106         }
 107
 108         $view = $request->get('view');
 109         if (!in_array($view, ['grid', 'list'])) {
 110             $view = 'list';
 111         }
 112
 113         $key = $type . '_view_type';
 114         setting()->putForCurrentUser($key, $view);
 115
 116         return redirect()->back(302, [], "/");
 117     }
 118
 119     /**
 120      * Change the stored sort type for a particular view.
 121      */
 122     public function changeSort(Request $request, string $type)
 123     {
 124         $validSortTypes = ['books', 'bookshelves', 'shelf_books', 'users', 'roles', 'webhooks', 'tags', 'page_revisions'];
 125         if (!in_array($type, $validSortTypes)) {
 126             return redirect()->back(500);
 127         }
 128
 129         $sort = substr($request->get('sort') ?: 'name', 0, 50);
 130         $order = $request->get('order') === 'desc' ? 'desc' : 'asc';
 131
 132         $sortKey = $type . '_sort';
 133         $orderKey = $type . '_sort_order';
 134         setting()->putForCurrentUser($sortKey, $sort);
 135         setting()->putForCurrentUser($orderKey, $order);
 136
 137         return redirect()->back(302, [], "/");
 138     }
 139
 140     /**
 141      * Toggle dark mode for the current user.
 142      */
 143     public function toggleDarkMode()
 144     {
 145         $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
 146         setting()->putForCurrentUser('dark-mode-enabled', $enabled ? 'false' : 'true');
 147
 148         return redirect()->back();
 149     }
 150
 151     /**
 152      * Update the stored section expansion preference for the given user.
 153      */
 154     public function changeExpansion(Request $request, string $type)
 155     {
 156         $typeWhitelist = ['home-details'];
 157         if (!in_array($type, $typeWhitelist)) {
 158             return response('Invalid key', 500);
 159         }
 160
 161         $newState = $request->get('expand', 'false');
 162         setting()->putForCurrentUser('section_expansion#' . $type, $newState);
 163
 164         return response('', 204);
 165     }
 166
 167     /**
 168      * Update the favorite status for a code language.
 169      */
 170     public function updateCodeLanguageFavourite(Request $request)
 171     {
 172         $validated = $this->validate($request, [
 173             'language' => ['required', 'string', 'max:20'],
 174             'active' => ['required', 'bool'],
 175         ]);
 176
 177         $currentFavoritesStr = setting()->getForCurrentUser('code-language-favourites', '');
 178         $currentFavorites = array_filter(explode(',', $currentFavoritesStr));
 179
 180         $isFav = in_array($validated['language'], $currentFavorites);
 181         if (!$isFav && $validated['active']) {
 182             $currentFavorites[] = $validated['language'];
 183         } elseif ($isFav && !$validated['active']) {
 184             $index = array_search($validated['language'], $currentFavorites);
 185             array_splice($currentFavorites, $index, 1);
 186         }
 187
 188         setting()->putForCurrentUser('code-language-favourites', implode(',', $currentFavorites));
 189         return response('', 204);
 190     }
 191 }