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         /** @var User $user */
 127         $user = $this->user->newQuery()->with(['apiTokens', 'mfaValues'])->findOrFail($id);
 128
 129         $authMethod = ($user->system_name) ? 'system' : config('auth.method');
 130
 131         $activeSocialDrivers = $socialAuthService->getActiveDrivers();
 132         $mfaMethods = $user->mfaValues->groupBy('method');
 133         $this->setPageTitle(trans('settings.user_profile'));
 134         $roles = $this->userRepo->getAllRoles();
 135
 136         return view('users.edit', [
 137             'user'                => $user,
 138             'activeSocialDrivers' => $activeSocialDrivers,
 139             'mfaMethods'          => $mfaMethods,
 140             'authMethod'          => $authMethod,
 141             'roles'               => $roles,
 142         ]);
 143     }
 144
 145     /**
 146      * Update the specified user in storage.
 147      *
 148      * @throws UserUpdateException
 149      * @throws ImageUploadException
 150      * @throws ValidationException
 151      */
 152     public function update(Request $request, int $id)
 153     {
 154         $this->preventAccessInDemoMode();
 155         $this->checkPermissionOrCurrentUser('users-manage', $id);
 156
 157         $this->validate($request, [
 158             'name'             => 'min:2',
 159             'email'            => 'min:2|email|unique:users,email,' . $id,
 160             'password'         => 'min:6|required_with:password_confirm',
 161             'password-confirm' => 'same:password|required_with:password',
 162             'setting'          => 'array',
 163             'profile_image'    => 'nullable|' . $this->getImageValidationRules(),
 164         ]);
 165
 166         $user = $this->userRepo->getById($id);
 167         $user->fill($request->except(['email']));
 168
 169         // Email updates
 170         if (userCan('users-manage') && $request->filled('email')) {
 171             $user->email = $request->get('email');
 172         }
 173
 174         // Refresh the slug if the user's name has changed
 175         if ($user->isDirty('name')) {
 176             $user->refreshSlug();
 177         }
 178
 179         // Role updates
 180         if (userCan('users-manage') && $request->filled('roles')) {
 181             $roles = $request->get('roles');
 182             $this->userRepo->setUserRoles($user, $roles);
 183         }
 184
 185         // Password updates
 186         if ($request->filled('password')) {
 187             $password = $request->get('password');
 188             $user->password = bcrypt($password);
 189         }
 190
 191         // External auth id updates
 192         if (user()->can('users-manage') && $request->filled('external_auth_id')) {
 193             $user->external_auth_id = $request->get('external_auth_id');
 194         }
 195
 196         // Save an user-specific settings
 197         if ($request->filled('setting')) {
 198             foreach ($request->get('setting') as $key => $value) {
 199                 setting()->putUser($user, $key, $value);
 200             }
 201         }
 202
 203         // Save profile image if in request
 204         if ($request->hasFile('profile_image')) {
 205             $imageUpload = $request->file('profile_image');
 206             $this->imageRepo->destroyImage($user->avatar);
 207             $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id);
 208             $user->image_id = $image->id;
 209         }
 210
 211         // Delete the profile image if reset option is in request
 212         if ($request->has('profile_image_reset')) {
 213             $this->imageRepo->destroyImage($user->avatar);
 214         }
 215
 216         $user->save();
 217         $this->showSuccessNotification(trans('settings.users_edit_success'));
 218         $this->logActivity(ActivityType::USER_UPDATE, $user);
 219
 220         $redirectUrl = userCan('users-manage') ? '/settings/users' : ('/settings/users/' . $user->id);
 221
 222         return redirect($redirectUrl);
 223     }
 224
 225     /**
 226      * Show the user delete page.
 227      */
 228     public function delete(int $id)
 229     {
 230         $this->checkPermissionOrCurrentUser('users-manage', $id);
 231
 232         $user = $this->userRepo->getById($id);
 233         $this->setPageTitle(trans('settings.users_delete_named', ['userName' => $user->name]));
 234
 235         return view('users.delete', ['user' => $user]);
 236     }
 237
 238     /**
 239      * Remove the specified user from storage.
 240      *
 241      * @throws Exception
 242      */
 243     public function destroy(Request $request, int $id)
 244     {
 245         $this->preventAccessInDemoMode();
 246         $this->checkPermissionOrCurrentUser('users-manage', $id);
 247
 248         $user = $this->userRepo->getById($id);
 249         $newOwnerId = $request->get('new_owner_id', null);
 250
 251         if ($this->userRepo->isOnlyAdmin($user)) {
 252             $this->showErrorNotification(trans('errors.users_cannot_delete_only_admin'));
 253
 254             return redirect($user->getEditUrl());
 255         }
 256
 257         if ($user->system_name === 'public') {
 258             $this->showErrorNotification(trans('errors.users_cannot_delete_guest'));
 259
 260             return redirect($user->getEditUrl());
 261         }
 262
 263         $this->userRepo->destroy($user, $newOwnerId);
 264         $this->showSuccessNotification(trans('settings.users_delete_success'));
 265         $this->logActivity(ActivityType::USER_DELETE, $user);
 266
 267         return redirect('/settings/users');
 268     }
 269
 270     /**
 271      * Update the user's preferred book-list display setting.
 272      */
 273     public function switchBooksView(Request $request, int $id)
 274     {
 275         return $this->switchViewType($id, $request, 'books');
 276     }
 277
 278     /**
 279      * Update the user's preferred shelf-list display setting.
 280      */
 281     public function switchShelvesView(Request $request, int $id)
 282     {
 283         return $this->switchViewType($id, $request, 'bookshelves');
 284     }
 285
 286     /**
 287      * Update the user's preferred shelf-view book list display setting.
 288      */
 289     public function switchShelfView(Request $request, int $id)
 290     {
 291         return $this->switchViewType($id, $request, 'bookshelf');
 292     }
 293
 294     /**
 295      * For a type of list, switch with stored view type for a user.
 296      */
 297     protected function switchViewType(int $userId, Request $request, string $listName)
 298     {
 299         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 300
 301         $viewType = $request->get('view_type');
 302         if (!in_array($viewType, ['grid', 'list'])) {
 303             $viewType = 'list';
 304         }
 305
 306         $user = $this->userRepo->getById($userId);
 307         $key = $listName . '_view_type';
 308         setting()->putUser($user, $key, $viewType);
 309
 310         return redirect()->back(302, [], "/settings/users/$userId");
 311     }
 312
 313     /**
 314      * Change the stored sort type for a particular view.
 315      */
 316     public function changeSort(Request $request, string $id, string $type)
 317     {
 318         $validSortTypes = ['books', 'bookshelves', 'shelf_books'];
 319         if (!in_array($type, $validSortTypes)) {
 320             return redirect()->back(500);
 321         }
 322
 323         return $this->changeListSort($id, $request, $type);
 324     }
 325
 326     /**
 327      * Toggle dark mode for the current user.
 328      */
 329     public function toggleDarkMode()
 330     {
 331         $enabled = setting()->getForCurrentUser('dark-mode-enabled', false);
 332         setting()->putUser(user(), 'dark-mode-enabled', $enabled ? 'false' : 'true');
 333
 334         return redirect()->back();
 335     }
 336
 337     /**
 338      * Update the stored section expansion preference for the given user.
 339      */
 340     public function updateExpansionPreference(Request $request, string $id, string $key)
 341     {
 342         $this->checkPermissionOrCurrentUser('users-manage', $id);
 343         $keyWhitelist = ['home-details'];
 344         if (!in_array($key, $keyWhitelist)) {
 345             return response('Invalid key', 500);
 346         }
 347
 348         $newState = $request->get('expand', 'false');
 349
 350         $user = $this->user->findOrFail($id);
 351         setting()->putUser($user, 'section_expansion#' . $key, $newState);
 352
 353         return response('', 204);
 354     }
 355
 356     /**
 357      * Changed the stored preference for a list sort order.
 358      */
 359     protected function changeListSort(int $userId, Request $request, string $listName)
 360     {
 361         $this->checkPermissionOrCurrentUser('users-manage', $userId);
 362
 363         $sort = $request->get('sort');
 364         if (!in_array($sort, ['name', 'created_at', 'updated_at', 'default'])) {
 365             $sort = 'name';
 366         }
 367
 368         $order = $request->get('order');
 369         if (!in_array($order, ['asc', 'desc'])) {
 370             $order = 'asc';
 371         }
 372
 373         $user = $this->user->findOrFail($userId);
 374         $sortKey = $listName . '_sort';
 375         $orderKey = $listName . '_sort_order';
 376         setting()->putUser($user, $sortKey, $sort);
 377         setting()->putUser($user, $orderKey, $order);
 378
 379         return redirect()->back(302, [], "/settings/users/$userId");
 380     }
 381 }