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