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