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