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

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