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