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

   1 <?php
   2
   3 namespace BookStack\Http\Controllers;
   4
   5 use BookStack\Auth\Access\SocialAuthService;
   6 use BookStack\Auth\User;
   7 use BookStack\Auth\UserRepo;
   8 use BookStack\Exceptions\ImageUploadException;
   9 use BookStack\Exceptions\UserUpdateException;
  10 use BookStack\Uploads\ImageRepo;
  11 use Exception;
  12 use Illuminate\Http\Request;
  13 use Illuminate\Support\Facades\DB;
  14 use Illuminate\Validation\Rules\Password;
  15 use Illuminate\Validation\ValidationException;
  16
  17 class UserController extends Controller
  18 {
  19     protected $userRepo;
  20     protected $imageRepo;
  21
  22     /**
  23      * UserController constructor.
  24      */
  25     public function __construct(UserRepo $userRepo, ImageRepo $imageRepo)
  26     {
  27         $this->userRepo = $userRepo;
  28         $this->imageRepo = $imageRepo;
  29     }
  30
  31     /**
  32      * Display a listing of the users.
  33      */
  34     public function index(Request $request)
  35     {
  36         $this->checkPermission('users-manage');
  37         $listDetails = [
  38             'order'  => $request->get('order', 'asc'),
  39             'search' => $request->get('search', ''),
  40             'sort'   => $request->get('sort', 'name'),
  41         ];
  42         $users = $this->userRepo->getAllUsersPaginatedAndSorted(20, $listDetails);
  43
  44         $this->setPageTitle(trans('settings.users'));
  45         $users->appends($listDetails);
  46
  47         return view('users.index', ['users' => $users, 'listDetails' => $listDetails]);
  48     }
  49
  50     /**
  51      * Show the form for creating a new user.
  52      */
  53     public function create()
  54     {
  55         $this->checkPermission('users-manage');
  56         $authMethod = config('auth.method');
  57         $roles = $this->userRepo->getAllRoles();
  58         $this->setPageTitle(trans('settings.users_add_new'));
  59
  60         return view('users.create', ['authMethod' => $authMethod, 'roles' => $roles]);
  61     }
  62
  63     /**
  64      * Store a new user in storage.
  65      *
  66      * @throws ValidationException
  67      */
  68     public function store(Request $request)
  69     {
  70         $this->checkPermission('users-manage');
  71
  72         $authMethod = config('auth.method');
  73         $sendInvite = ($request->get('send_invite', 'false') === 'true');
  74         $externalAuth = $authMethod === 'ldap' || $authMethod === 'saml2' || $authMethod === 'oidc';
  75         $passwordRequired = ($authMethod === 'standard' && !$sendInvite);
  76
  77         $validationRules = [
  78             'name'    => ['required'],
  79             'email'   => ['required', 'email', 'unique:users,email'],
  80             'language' => ['string'],
  81             'roles'            => ['array'],
  82             'roles.*'          => ['integer'],
  83             'password' => $passwordRequired ? ['required', Password::default()] : null,
  84             'password-confirm' => $passwordRequired ? ['required', 'same:password'] : null,
  85             'external_auth_id' => $externalAuth ? ['required'] : null,
  86         ];
  87
  88         $validated = $this->validate($request, array_filter($validationRules));
  89
  90         DB::transaction(function () use ($validated, $sendInvite) {
  91             $this->userRepo->create($validated, $sendInvite);
  92         });
  93
  94         return redirect('/settings/users');
  95     }
  96
  97     /**
  98      * Show the form for editing the specified user.
  99      */
 100     public function edit(int $id, SocialAuthService $socialAuthService)
 101     {
 102         $this->checkPermissionOrCurrentUser('users-manage', $id);
 103
 104         /** @var User $user */
 105         $user = User::query()->with(['apiTokens', 'mfaValues'])->findOrFail($id);
 106
 107         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 108
 109         $activeSocialDrivers = $socialAuthService->getActiveDrivers();
 110         $mfaMethods = $user->mfaValues->groupBy('method');
 111         $this->setPageTitle(trans('settings.user_profile'));
 112         $roles = $this->userRepo->getAllRoles();
 113
 114         return view('users.edit', [
 115             'user'                => $user,
 116             'activeSocialDrivers' => $activeSocialDrivers,
 117             'mfaMethods'          => $mfaMethods,
 118             'authMethod'          => $authMethod,
 119             'roles'               => $roles,
 120         ]);
 121     }
 122
 123     /**
 124      * Update the specified user in storage.
 125      *
 126      * @throws UserUpdateException
 127      * @throws ImageUploadException
 128      * @throws ValidationException
 129      */
 130     public function update(Request $request, int $id)
 131     {
 132         $this->preventAccessInDemoMode();
 133         $this->checkPermissionOrCurrentUser('users-manage', $id);
 134
 135         $validated = $this->validate($request, [
 136             'name'             => ['min:2'],
 137             'email'            => ['min:2', 'email', 'unique:users,email,' . $id],
 138             'password'         => ['required_with:password_confirm', Password::default()],
 139             'password-confirm' => ['same:password', 'required_with:password'],
 140             'language'         => ['string'],
 141             'roles'            => ['array'],
 142             'roles.*'          => ['integer'],
 143             'profile_image'    => array_merge(['nullable'], $this->getImageValidationRules()),
 144         ]);
 145
 146         $user = $this->userRepo->getById($id);
 147         $this->userRepo->update($user, $validated, userCan('users-manage'));
 148
 149         // Save profile image if in request
 150         if ($request->hasFile('profile_image')) {
 151             $imageUpload = $request->file('profile_image');
 152             $this->imageRepo->destroyImage($user->avatar);
 153             $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
 154             $user->image_id = $image->id;
 155             $user->save();
 156         }
 157
 158         // Delete the profile image if reset option is in request
 159         if ($request->has('profile_image_reset')) {
 160             $this->imageRepo->destroyImage($user->avatar);
 161         }
 162
 163         $redirectUrl = userCan('users-manage') ? '/settings/users' : "/settings/users/{$user->id}";
 164
 165         return redirect($redirectUrl);
 166     }
 167
 168     /**
 169      * Show the user delete page.
 170      */
 171     public function delete(int $id)
 172     {
 173         $this->checkPermissionOrCurrentUser('users-manage', $id);
 174
 175         $user = $this->userRepo->getById($id);
 176         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));
 177
 178         return view('users.delete', ['user' => $user]);
 179     }
 180
 181     /**
 182      * Remove the specified user from storage.
 183      *
 184      * @throws Exception
 185      */
 186     public function destroy(Request $request, int $id)
 187     {
 188         $this->preventAccessInDemoMode();
 189         $this->checkPermissionOrCurrentUser('users-manage', $id);
 190
 191         $user = $this->userRepo->getById($id);
 192         $newOwnerId = $request->get('new_owner_id', null);
 193
 194         $this->userRepo->destroy($user, $newOwnerId);
 195
 196         return redirect('/settings/users');
 197     }
 198
 199     /**
 200      * Update the user's preferred book-list display setting.
 201      */
 202     public function switchBooksView(Request $request, int $id)
 203     {
 204         return $this->switchViewType($id, $request, 'books');
 205     }
 206
 207     /**
 208      * Update the user's preferred shelf-list display setting.
 209      */
 210     public function switchShelvesView(Request $request, int $id)
 211     {
 212         return $this->switchViewType($id, $request, 'bookshelves');
 213     }
 214
 215     /**
 216      * Update the user's preferred shelf-view book list display setting.
 217      */
 218     public function switchShelfView(Request $request, int $id)
 219     {
 220         return $this->switchViewType($id, $request, 'bookshelf');
 221     }
 222
 223     /**
 224      * For a type of list, switch with stored view type for a user.
 225      */
 226     protected function switchViewType(int $userId, Request $request, string $listName)
 227     {
 228         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 229
 230         $viewType = $request->get('view_type');
 231         if (!in_array($viewType, ['grid', 'list'])) {
 232             $viewType = 'list';
 233         }
 234
 235         $user = $this->userRepo->getById($userId);
 236         $key = $listName . '_view_type';
 237         setting()->putUser($user, $key, $viewType);
 238
 239         return redirect()->back(302, [], "/settings/users/$userId");
 240     }
 241
 242     /**
 243      * Change the stored sort type for a particular view.
 244      */
 245     public function changeSort(Request $request, string $id, string $type)
 246     {
 247         $validSortTypes = ['books', 'bookshelves', 'shelf_books'];
 248         if (!in_array($type, $validSortTypes)) {
 249             return redirect()->back(500);
 250         }
 251
 252         return $this->changeListSort($id, $request, $type);
 253     }
 254
 255     /**
 256      * Toggle dark mode for the current user.
 257      */
 258     public function toggleDarkMode()
 259     {
 260         $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
 261         setting()->putUser(user(), 'dark-mode-enabled', $enabled ? 'false' : 'true');
 262
 263         return redirect()->back();
 264     }
 265
 266     /**
 267      * Update the stored section expansion preference for the given user.
 268      */
 269     public function updateExpansionPreference(Request $request, string $id, string $key)
 270     {
 271         $this->checkPermissionOrCurrentUser('users-manage', $id);
 272         $keyWhitelist = ['home-details'];
 273         if (!in_array($key, $keyWhitelist)) {
 274             return response('Invalid key', 500);
 275         }
 276
 277         $newState = $request->get('expand', 'false');
 278
 279         $user = $this->userRepo->getById($id);
 280         setting()->putUser($user, 'section_expansion#' . $key, $newState);
 281
 282         return response('', 204);
 283     }
 284
 285     /**
 286      * Changed the stored preference for a list sort order.
 287      */
 288     protected function changeListSort(int $userId, Request $request, string $listName)
 289     {
 290         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 291
 292         $sort = $request->get('sort');
 293         if (!in_array($sort, ['name', 'created_at', 'updated_at', 'default'])) {
 294             $sort = 'name';
 295         }
 296
 297         $order = $request->get('order');
 298         if (!in_array($order, ['asc', 'desc'])) {
 299             $order = 'asc';
 300         }
 301
 302         $user = $this->userRepo->getById($userId);
 303         $sortKey = $listName . '_sort';
 304         $orderKey = $listName . '_sort_order';
 305         setting()->putUser($user, $sortKey, $sort);
 306         setting()->putUser($user, $orderKey, $order);
 307
 308         return redirect()->back(302, [], "/settings/users/$userId");
 309     }
 310 }