X-Git-Url: http://source.bookstackapp.com/bookstack/blobdiff_plain/b8c16b15a9f945b72d2ca4fe0c0172ba422199bc..refs/pull/3260/head:/app/Auth/UserRepo.php diff --git a/app/Auth/UserRepo.php b/app/Auth/UserRepo.php index cfa7bfce1..606fd5d65 100644 --- a/app/Auth/UserRepo.php +++ b/app/Auth/UserRepo.php @@ -1,31 +1,38 @@ -user = $user; - $this->role = $role; + $this->userAvatar = $userAvatar; + $this->inviteService = $inviteService; } /** @@ -33,36 +40,50 @@ class UserRepo */ public function getByEmail(string $email): ?User { - return $this->user->where('email', '=', $email)->first(); + return User::query()->where('email', '=', $email)->first(); + } + + /** + * Get a user by their ID. + */ + public function getById(int $id): User + { + return User::query()->findOrFail($id); } /** - * @param int $id - * @return User + * Get a user by their slug. */ - public function getById($id) + public function getBySlug(string $slug): User { - return $this->user->newQuery()->findOrFail($id); + return User::query()->where('slug', '=', $slug)->firstOrFail(); } /** - * Get all the users with their permissions. - * @return Builder|static + * Get all users as Builder for API. */ - public function getAllUsers() + public function getApiUsersBuilder(): Builder { - return $this->user->with('roles', 'avatar')->orderBy('name', 'asc')->get(); + return User::query()->select(['*']) + ->scopes('withLastActivityAt') + ->with(['avatar']); } /** * Get all the users with their permissions in a paginated format. - * @param int $count - * @param $sortData - * @return Builder|static + * Note: Due to the use of email search this should only be used when + * user is assumed to be trusted. (Admin users). + * Email search can be abused to extract email addresses. */ - public function getAllUsersPaginatedAndSorted($count, $sortData) + public function getAllUsersPaginatedAndSorted(int $count, array $sortData): LengthAwarePaginator { - $query = $this->user->with('roles', 'avatar')->orderBy($sortData['sort'], $sortData['order']); + $sort = $sortData['sort']; + + $query = User::query()->select(['*']) + ->scopes(['withLastActivityAt']) + ->with(['roles', 'avatar']) + ->withCount('mfaValues') + ->orderBy($sort, $sortData['order']); if ($sortData['search']) { $term = '%' . $sortData['search'] . '%'; @@ -75,28 +96,15 @@ class UserRepo return $query->paginate($count); } - /** - * Creates a new user and attaches a role to them. - */ - public function registerNew(array $data, bool $emailConfirmed = false): User - { - $user = $this->create($data, $emailConfirmed); - $user->attachDefaultRole(); - $this->downloadAndAssignUserAvatar($user); - - return $user; - } - /** * Assign a user to a system-level role. - * @param User $user - * @param $systemRoleName + * * @throws NotFoundException */ - public function attachSystemRole(User $user, $systemRoleName) + public function attachSystemRole(User $user, string $systemRoleName) { - $role = $this->role->newQuery()->where('system_name', '=', $systemRoleName)->first(); - if ($role === null) { + $role = Role::getSystemRole($systemRoleName); + if (is_null($role)) { throw new NotFoundException("Role '{$systemRoleName}' not found"); } $user->attachRole($role); @@ -104,26 +112,24 @@ class UserRepo /** * Checks if the give user is the only admin. - * @param User $user - * @return bool */ - public function isOnlyAdmin(User $user) + public function isOnlyAdmin(User $user): bool { if (!$user->hasSystemRole('admin')) { return false; } - $adminRole = $this->role->getSystemRole('admin'); - if ($adminRole->users->count() > 1) { + $adminRole = Role::getSystemRole('admin'); + if ($adminRole->users()->count() > 1) { return false; } + return true; } /** * Set the assigned user roles via an array of role IDs. - * @param User $user - * @param array $roles + * * @throws UserUpdateException */ public function setUserRoles(User $user, array $roles) @@ -138,14 +144,11 @@ class UserRepo /** * Check if the given user is the last admin and their new roles no longer * contains the admin role. - * @param User $user - * @param array $newRoles - * @return bool */ - protected function demotingLastAdmin(User $user, array $newRoles) : bool + protected function demotingLastAdmin(User $user, array $newRoles): bool { if ($this->isOnlyAdmin($user)) { - $adminRole = $this->role->getSystemRole('admin'); + $adminRole = Role::getSystemRole('admin'); if (!in_array(strval($adminRole->id), $newRoles)) { return true; } @@ -155,47 +158,145 @@ class UserRepo } /** - * Create a new basic instance of user. + * Create a new basic instance of user with the given pre-validated data. + * + * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data + */ + public function createWithoutActivity(array $data, bool $emailConfirmed = false): User + { + $user = new User(); + $user->name = $data['name']; + $user->email = $data['email']; + $user->password = bcrypt(empty($data['password']) ? Str::random(32) : $data['password']); + $user->email_confirmed = $emailConfirmed; + $user->external_auth_id = $data['external_auth_id'] ?? ''; + + $user->refreshSlug(); + $user->save(); + + if (!empty($data['language'])) { + setting()->putUser($user, 'language', $data['language']); + } + + if (isset($data['roles'])) { + $this->setUserRoles($user, $data['roles']); + } + + $this->downloadAndAssignUserAvatar($user); + + return $user; + } + + /** + * As per "createWithoutActivity" but records a "create" activity. + * + * @param array{name: string, email: string, password: ?string, external_auth_id: ?string, language: ?string, roles: ?array} $data */ - public function create(array $data, bool $emailConfirmed = false): User + public function create(array $data, bool $sendInvite = false): User { - return $this->user->forceCreate([ - 'name' => $data['name'], - 'email' => $data['email'], - 'password' => bcrypt($data['password']), - 'email_confirmed' => $emailConfirmed, - 'external_auth_id' => $data['external_auth_id'] ?? '', - ]); + $user = $this->createWithoutActivity($data, true); + + if ($sendInvite) { + $this->inviteService->sendInvitation($user); + } + + Activity::add(ActivityType::USER_CREATE, $user); + + return $user; + } + + /** + * Update the given user with the given data. + * + * @param array{name: ?string, email: ?string, external_auth_id: ?string, password: ?string, roles: ?array, language: ?string} $data + * + * @throws UserUpdateException + */ + public function update(User $user, array $data, bool $manageUsersAllowed): User + { + if (!empty($data['name'])) { + $user->name = $data['name']; + $user->refreshSlug(); + } + + if (!empty($data['email']) && $manageUsersAllowed) { + $user->email = $data['email']; + } + + if (!empty($data['external_auth_id']) && $manageUsersAllowed) { + $user->external_auth_id = $data['external_auth_id']; + } + + if (isset($data['roles']) && $manageUsersAllowed) { + $this->setUserRoles($user, $data['roles']); + } + + if (!empty($data['password'])) { + $user->password = bcrypt($data['password']); + } + + if (!empty($data['language'])) { + setting()->putUser($user, 'language', $data['language']); + } + + $user->save(); + Activity::add(ActivityType::USER_UPDATE, $user); + + return $user; } /** * Remove the given user from storage, Delete all related content. - * @param User $user + * * @throws Exception */ - public function destroy(User $user) + public function destroy(User $user, ?int $newOwnerId = null) { + $this->ensureDeletable($user); + $user->socialAccounts()->delete(); $user->apiTokens()->delete(); + $user->favourites()->delete(); + $user->mfaValues()->delete(); $user->delete(); - + // Delete user profile images - $profileImages = Image::where('type', '=', 'user')->where('uploaded_to', '=', $user->id)->get(); - foreach ($profileImages as $image) { - Images::destroy($image); + $this->userAvatar->destroyAllForUser($user); + + if (!empty($newOwnerId)) { + $newOwner = User::query()->find($newOwnerId); + if (!is_null($newOwner)) { + $this->migrateOwnership($user, $newOwner); + } + } + + Activity::add(ActivityType::USER_DELETE, $user); + } + + /** + * @throws NotifyException + */ + protected function ensureDeletable(User $user): void + { + if ($this->isOnlyAdmin($user)) { + throw new NotifyException(trans('errors.users_cannot_delete_only_admin'), $user->getEditUrl()); + } + + if ($user->system_name === 'public') { + throw new NotifyException(trans('errors.users_cannot_delete_guest'), $user->getEditUrl()); } } /** - * Get the latest activity for a user. - * @param User $user - * @param int $count - * @param int $page - * @return array + * Migrate ownership of items in the system from one user to another. */ - public function getActivity(User $user, $count = 20, $page = 0) + protected function migrateOwnership(User $fromUser, User $toUser) { - return Activity::userActivity($user, $count, $page); + $entities = (new EntityProvider())->all(); + foreach ($entities as $instance) { + $instance->newQuery()->where('owned_by', '=', $fromUser->id) + ->update(['owned_by' => $toUser->id]); + } } /** @@ -224,43 +325,33 @@ class UserRepo public function getAssetCounts(User $user): array { $createdBy = ['created_by' => $user->id]; + return [ - 'pages' => Page::visible()->where($createdBy)->count(), - 'chapters' => Chapter::visible()->where($createdBy)->count(), - 'books' => Book::visible()->where($createdBy)->count(), - 'shelves' => Bookshelf::visible()->where($createdBy)->count(), + 'pages' => Page::visible()->where($createdBy)->count(), + 'chapters' => Chapter::visible()->where($createdBy)->count(), + 'books' => Book::visible()->where($createdBy)->count(), + 'shelves' => Bookshelf::visible()->where($createdBy)->count(), ]; } /** * Get the roles in the system that are assignable to a user. - * @return mixed */ - public function getAllRoles() + public function getAllRoles(): Collection { - return $this->role->newQuery()->orderBy('name', 'asc')->get(); + return Role::query()->orderBy('display_name', 'asc')->get(); } /** * Get an avatar image for a user and set it as their avatar. * Returns early if avatars disabled or not set in config. - * @param User $user - * @return bool */ - public function downloadAndAssignUserAvatar(User $user) + public function downloadAndAssignUserAvatar(User $user): void { - if (!Images::avatarFetchEnabled()) { - return false; - } - try { - $avatar = Images::saveUserAvatar($user); - $user->avatar()->associate($avatar); - $user->save(); - return true; + $this->userAvatar->fetchAndAssignToUser($user); } catch (Exception $e) { Log::error('Failed to save user avatar image'); - return false; } } }