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