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

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