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