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