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

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Auth\UserRepo;
   6 use Illuminate\Http\Request;
   7
   8 class UserPreferencesController extends Controller
   9 {
  10     protected UserRepo $userRepo;
  11
  12     public function __construct(UserRepo $userRepo)
  13     {
  14         $this->userRepo = $userRepo;
  15     }
  16
  17     /**
  18      * Update the user's preferred book-list display setting.
  19      */
  20     public function switchBooksView(Request $request, int $id)
  21     {
  22         return $this->switchViewType($id, $request, 'books');
  23     }
  24
  25     /**
  26      * Update the user's preferred shelf-list display setting.
  27      */
  28     public function switchShelvesView(Request $request, int $id)
  29     {
  30         return $this->switchViewType($id, $request, 'bookshelves');
  31     }
  32
  33     /**
  34      * Update the user's preferred shelf-view book list display setting.
  35      */
  36     public function switchShelfView(Request $request, int $id)
  37     {
  38         return $this->switchViewType($id, $request, 'bookshelf');
  39     }
  40
  41     /**
  42      * For a type of list, switch with stored view type for a user.
  43      */
  44     protected function switchViewType(int $userId, Request $request, string $listName)
  45     {
  46         $this->checkPermissionOrCurrentUser('users-manage', $userId);
  47
  48         $viewType = $request->get('view_type');
  49         if (!in_array($viewType, ['grid', 'list'])) {
  50             $viewType = 'list';
  51         }
  52
  53         $user = $this->userRepo->getById($userId);
  54         $key = $listName . '_view_type';
  55         setting()->putUser($user, $key, $viewType);
  56
  57         return redirect()->back(302, [], "/settings/users/$userId");
  58     }
  59
  60     /**
  61      * Change the stored sort type for a particular view.
  62      */
  63     public function changeSort(Request $request, string $id, string $type)
  64     {
  65         $validSortTypes = ['books', 'bookshelves', 'shelf_books', 'users', 'roles', 'webhooks', 'tags', 'page_revisions'];
  66         if (!in_array($type, $validSortTypes)) {
  67             return redirect()->back(500);
  68         }
  69
  70         $this->checkPermissionOrCurrentUser('users-manage', $id);
  71
  72         $sort = substr($request->get('sort') ?: 'name', 0, 50);
  73         $order = $request->get('order') === 'desc' ? 'desc' : 'asc';
  74
  75         $user = $this->userRepo->getById($id);
  76         $sortKey = $type . '_sort';
  77         $orderKey = $type . '_sort_order';
  78         setting()->putUser($user, $sortKey, $sort);
  79         setting()->putUser($user, $orderKey, $order);
  80
  81         return redirect()->back(302, [], "/settings/users/{$id}");
  82     }
  83
  84     /**
  85      * Toggle dark mode for the current user.
  86      */
  87     public function toggleDarkMode()
  88     {
  89         $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
  90         setting()->putUser(user(), 'dark-mode-enabled', $enabled ? 'false' : 'true');
  91
  92         return redirect()->back();
  93     }
  94
  95     /**
  96      * Update the stored section expansion preference for the given user.
  97      */
  98     public function updateExpansionPreference(Request $request, string $id, string $key)
  99     {
 100         $this->checkPermissionOrCurrentUser('users-manage', $id);
 101         $keyWhitelist = ['home-details'];
 102         if (!in_array($key, $keyWhitelist)) {
 103             return response('Invalid key', 500);
 104         }
 105
 106         $newState = $request->get('expand', 'false');
 107
 108         $user = $this->userRepo->getById($id);
 109         setting()->putUser($user, 'section_expansion#' . $key, $newState);
 110
 111         return response('', 204);
 112     }
 113
 114     public function updateCodeLanguageFavourite(Request $request)
 115     {
 116         $validated = $this->validate($request, [
 117             'language' => ['required', 'string', 'max:20'],
 118             'active'   => ['required', 'bool'],
 119         ]);
 120
 121         $currentFavoritesStr = setting()->getForCurrentUser('code-language-favourites', '');
 122         $currentFavorites = array_filter(explode(',', $currentFavoritesStr));
 123
 124         $isFav = in_array($validated['language'], $currentFavorites);
 125         if (!$isFav && $validated['active']) {
 126             $currentFavorites[] = $validated['language'];
 127         } elseif ($isFav && !$validated['active']) {
 128             $index = array_search($validated['language'], $currentFavorites);
 129             array_splice($currentFavorites, $index, 1);
 130         }
 131
 132         setting()->putUser(user(), 'code-language-favourites', implode(',', $currentFavorites));
 133     }
 134 }