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

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