X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/444a23a419539b9236a3cf04cf5c76c2d216c49e..refs/pull/2023/head:/app/Http/Controllers/UserController.php diff --git a/app/Http/Controllers/UserController.php b/app/Http/Controllers/UserController.php index c9d2560ba..43cbad1fb 100644 --- a/app/Http/Controllers/UserController.php +++ b/app/Http/Controllers/UserController.php @@ -7,7 +7,7 @@ use BookStack\Auth\UserRepo; use BookStack\Exceptions\UserUpdateException; use BookStack\Uploads\ImageRepo; use Illuminate\Http\Request; -use Illuminate\Http\Response; +use Illuminate\Support\Str; class UserController extends Controller { @@ -19,10 +19,6 @@ class UserController extends Controller /** * UserController constructor. - * @param User $user - * @param UserRepo $userRepo - * @param UserInviteService $inviteService - * @param ImageRepo $imageRepo */ public function __construct(User $user, UserRepo $userRepo, UserInviteService $inviteService, ImageRepo $imageRepo) { @@ -35,8 +31,6 @@ class UserController extends Controller /** * Display a listing of the users. - * @param Request $request - * @return Response */ public function index(Request $request) { @@ -54,7 +48,6 @@ class UserController extends Controller /** * Show the form for creating a new user. - * @return Response */ public function create() { @@ -66,9 +59,8 @@ class UserController extends Controller /** * Store a newly created user in storage. - * @param Request $request - * @return Response * @throws UserUpdateException + * @throws \Illuminate\Validation\ValidationException */ public function store(Request $request) { @@ -92,7 +84,7 @@ class UserController extends Controller $user = $this->user->fill($request->all()); if ($authMethod === 'standard') { - $user->password = bcrypt($request->get('password', str_random(32))); + $user->password = bcrypt($request->get('password', Str::random(32))); } elseif ($authMethod === 'ldap') { $user->external_auth_id = $request->get('external_auth_id'); } @@ -115,35 +107,35 @@ class UserController extends Controller /** * Show the form for editing the specified user. - * @param int $id - * @param \BookStack\Auth\Access\SocialAuthService $socialAuthService - * @return Response */ - public function edit($id, SocialAuthService $socialAuthService) + public function edit(int $id, SocialAuthService $socialAuthService) { $this->checkPermissionOrCurrentUser('users-manage', $id); - $user = $this->user->findOrFail($id); + $user = $this->user->newQuery()->with(['apiTokens'])->findOrFail($id); $authMethod = ($user->system_name) ? 'system' : config('auth.method'); $activeSocialDrivers = $socialAuthService->getActiveDrivers(); $this->setPageTitle(trans('settings.user_profile')); $roles = $this->userRepo->getAllRoles(); - return view('users.edit', ['user' => $user, 'activeSocialDrivers' => $activeSocialDrivers, 'authMethod' => $authMethod, 'roles' => $roles]); + return view('users.edit', [ + 'user' => $user, + 'activeSocialDrivers' => $activeSocialDrivers, + 'authMethod' => $authMethod, + 'roles' => $roles + ]); } /** * Update the specified user in storage. - * @param Request $request - * @param int $id - * @return Response * @throws UserUpdateException * @throws \BookStack\Exceptions\ImageUploadException + * @throws \Illuminate\Validation\ValidationException */ - public function update(Request $request, $id) + public function update(Request $request, int $id) { - $this->preventAccessForDemoUsers(); + $this->preventAccessInDemoMode(); $this->checkPermissionOrCurrentUser('users-manage', $id); $this->validate($request, [ @@ -152,7 +144,7 @@ class UserController extends Controller 'password' => 'min:6|required_with:password_confirm', 'password-confirm' => 'same:password|required_with:password', 'setting' => 'array', - 'profile_image' => $this->imageRepo->getImageValidationRules(), + 'profile_image' => 'nullable|' . $this->getImageValidationRules(), ]); $user = $this->userRepo->getById($id); @@ -176,7 +168,7 @@ class UserController extends Controller } // External auth id updates - if ($this->currentUser->can('users-manage') && $request->filled('external_auth_id')) { + if (user()->can('users-manage') && $request->filled('external_auth_id')) { $user->external_auth_id = $request->get('external_auth_id'); } @@ -188,7 +180,7 @@ class UserController extends Controller } // Save profile image if in request - if ($request->has('profile_image')) { + if ($request->hasFile('profile_image')) { $imageUpload = $request->file('profile_image'); $this->imageRepo->destroyImage($user->avatar); $image = $this->imageRepo->saveNew($imageUpload, 'user', $user->id); @@ -201,7 +193,7 @@ class UserController extends Controller } $user->save(); - session()->flash('success', trans('settings.users_edit_success')); + $this->showSuccessNotification(trans('settings.users_edit_success')); $redirectUrl = userCan('users-manage') ? '/settings/users' : ('/settings/users/' . $user->id); return redirect($redirectUrl); @@ -209,10 +201,8 @@ class UserController extends Controller /** * Show the user delete page. - * @param int $id - * @return \Illuminate\View\View */ - public function delete($id) + public function delete(int $id) { $this->checkPermissionOrCurrentUser('users-manage', $id); @@ -223,44 +213,40 @@ class UserController extends Controller /** * Remove the specified user from storage. - * @param int $id - * @return Response * @throws \Exception */ - public function destroy($id) + public function destroy(int $id) { - $this->preventAccessForDemoUsers(); + $this->preventAccessInDemoMode(); $this->checkPermissionOrCurrentUser('users-manage', $id); $user = $this->userRepo->getById($id); if ($this->userRepo->isOnlyAdmin($user)) { - session()->flash('error', trans('errors.users_cannot_delete_only_admin')); + $this->showErrorNotification(trans('errors.users_cannot_delete_only_admin')); return redirect($user->getEditUrl()); } if ($user->system_name === 'public') { - session()->flash('error', trans('errors.users_cannot_delete_guest')); + $this->showErrorNotification(trans('errors.users_cannot_delete_guest')); return redirect($user->getEditUrl()); } $this->userRepo->destroy($user); - session()->flash('success', trans('settings.users_delete_success')); + $this->showSuccessNotification(trans('settings.users_delete_success')); return redirect('/settings/users'); } /** * Show the user profile page - * @param $id - * @return \Illuminate\Contracts\View\Factory|\Illuminate\View\View */ public function showProfilePage($id) { $user = $this->userRepo->getById($id); $userActivity = $this->userRepo->getActivity($user); - $recentlyCreated = $this->userRepo->getRecentlyCreated($user, 5, 0); + $recentlyCreated = $this->userRepo->getRecentlyCreated($user, 5); $assetCounts = $this->userRepo->getAssetCounts($user); return view('users.profile', [ @@ -273,34 +259,32 @@ class UserController extends Controller /** * Update the user's preferred book-list display setting. - * @param $id - * @param Request $request - * @return \Illuminate\Http\RedirectResponse */ - public function switchBookView($id, Request $request) + public function switchBooksView(Request $request, int $id) { return $this->switchViewType($id, $request, 'books'); } /** * Update the user's preferred shelf-list display setting. - * @param $id - * @param Request $request - * @return \Illuminate\Http\RedirectResponse */ - public function switchShelfView($id, Request $request) + public function switchShelvesView(Request $request, int $id) { return $this->switchViewType($id, $request, 'bookshelves'); } + /** + * Update the user's preferred shelf-view book list display setting. + */ + public function switchShelfView(Request $request, int $id) + { + return $this->switchViewType($id, $request, 'bookshelf'); + } + /** * For a type of list, switch with stored view type for a user. - * @param integer $userId - * @param Request $request - * @param string $listName - * @return \Illuminate\Http\RedirectResponse */ - protected function switchViewType($userId, Request $request, string $listName) + protected function switchViewType(int $userId, Request $request, string $listName) { $this->checkPermissionOrCurrentUser('users-manage', $userId); @@ -318,12 +302,8 @@ class UserController extends Controller /** * Change the stored sort type for a particular view. - * @param string $id - * @param string $type - * @param Request $request - * @return \Illuminate\Http\RedirectResponse */ - public function changeSort(string $id, string $type, Request $request) + public function changeSort(Request $request, string $id, string $type) { $validSortTypes = ['books', 'bookshelves']; if (!in_array($type, $validSortTypes)) { @@ -334,12 +314,8 @@ class UserController extends Controller /** * Update the stored section expansion preference for the given user. - * @param string $id - * @param string $key - * @param Request $request - * @return \Illuminate\Contracts\Routing\ResponseFactory|\Symfony\Component\HttpFoundation\Response */ - public function updateExpansionPreference(string $id, string $key, Request $request) + public function updateExpansionPreference(Request $request, string $id, string $key) { $this->checkPermissionOrCurrentUser('users-manage', $id); $keyWhitelist = ['home-details']; @@ -356,10 +332,6 @@ class UserController extends Controller /** * Changed the stored preference for a list sort order. - * @param int $userId - * @param Request $request - * @param string $listName - * @return \Illuminate\Http\RedirectResponse */ protected function changeListSort(int $userId, Request $request, string $listName) {